Compare commits
47
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
0378b7dfa2 | ||
|
|
5d6434c360 | ||
|
|
102dcdd3f1 | ||
|
|
43e0c2b347 | ||
|
|
1d1d4ff855 | ||
|
|
f7129807e6 | ||
|
|
be96564a8f | ||
|
|
e24f09ae8a | ||
|
|
80155d7638 | ||
|
|
8b4cccbb25 | ||
|
|
2dd0e4f271 | ||
|
|
e2675cd91c | ||
|
|
8f24854aa5 | ||
|
|
dca740e94b | ||
|
|
b29993ba82 | ||
|
|
e20bf9abc0 | ||
|
|
5440f8a34a | ||
|
|
dc329c09b4 | ||
|
|
1a8a3cb713 | ||
|
|
afe498452b | ||
|
|
3838e26422 | ||
|
|
f70a9153fa | ||
|
|
4f02a17380 | ||
|
|
c97bf8bd98 | ||
|
|
59be004be1 | ||
|
|
aec1736a1f | ||
|
|
5694ec91f7 | ||
|
|
b693207387 | ||
|
|
33a5da1373 | ||
|
|
3df56f0ca1 | ||
|
|
80b4437169 | ||
|
|
268ad75585 | ||
|
|
3d7c273e3b | ||
|
|
29b84832ee | ||
|
|
cd4f69af1a | ||
|
|
80d1048235 | ||
|
|
70a81ed765 | ||
|
|
c02ee63a4e | ||
|
|
f8d4945e6d | ||
|
|
fc8072019e | ||
|
|
2c9bc3e17c | ||
|
|
aa30080e06 | ||
|
|
39a747f2a3 | ||
|
|
47f010a7b7 | ||
|
|
28c7760d28 | ||
|
|
92affcd11e | ||
|
|
d3e8dd3609 |
No files matched your search
+1
-1
@@ -9,7 +9,7 @@ barrier. It is written for the person who has just met one; the details for deve
|
||||
FrameLedger is a desktop program: its own window, its dialogs, its document windows, the icon by the clock and the
|
||||
notices Windows shows for it. It draws nothing inside a game, so it cannot make a game itself any easier to use.
|
||||
|
||||
*Beta software: this page describes version 0.1.0-beta.45. In the app: Help ▸ Accessibility.*
|
||||
*Beta software: this page describes version 0.1.0-beta.49. In the app: Help ▸ Accessibility.*
|
||||
|
||||
## What FrameLedger aims for
|
||||
|
||||
|
||||
@@ -35,12 +35,79 @@ numeric core and does not move; the heading is the full version — corrected 20
|
||||
|
||||
## [Unreleased]
|
||||
|
||||
### Added
|
||||
|
||||
- **For developers: the arithmetic of controller statistics, with nothing reading a device yet** (D155–D163, the
|
||||
owner's decisions of 2026-11-14; `docs/21_INPUT_DEVICES.md`, `docs/03_METRICS.md` §Input). `FrameLedger.Domain.Input`
|
||||
says whether an XInput state or a DualSense report is a pad in use and what its battery is, adds a battery's readings
|
||||
up, counts switches, and decides when two entries are one pad seen twice; `Application.Input` holds one session's
|
||||
slices and turns them into a reading a second; `InputSessionBuilder` turns a session's readings into its totals, its
|
||||
controllers as JSON and its timeline. A telemetry sample can carry a reading; none does. **Every byte and reading
|
||||
under test was written by hand — no report from a real controller has passed through this code.**
|
||||
- **For developers: a session can store what it was played with — schema 0024** (D160; `docs/06_DATA_MODEL.md`). Nine
|
||||
columns on `sessions` (the time in front and its four classes, the switches of method, the sources that answered,
|
||||
the controllers as JSON) and three on `games` (what a store lists of controller support), ADD COLUMN only; the
|
||||
`.partial` file gains chunk 11, so a session recovered after the Agent died keeps its readings; the finalizer
|
||||
stores them for hooked and unhooked sessions alike; the input series are `sensor_blobs` rows named `input.*`, which
|
||||
the sensors' read leaves out. Nothing produces a reading yet. **A ledger this build has opened cannot be opened by
|
||||
0.1.0-beta.49 or earlier.**
|
||||
- **For developers: the input reader, which the Agent does not start yet** (D155, D158, D159; `docs/21_INPUT_DEVICES.md`
|
||||
§The reader). `Application.Input.InputReader` takes a slice about ten times a second from
|
||||
`Infrastructure.Input.Win32InputBackend` — raw input for joysticks and gamepads delivered to a window that is never
|
||||
shown, three of XInput's getters, the time of the last keyboard or mouse input, the window in front — on the thread
|
||||
of `InputDeviceHub`, which exists only while a session has a view of it. It opens no device, sends nothing to one,
|
||||
and registers for no keyboard or mouse. A new gate, `tools/input-readonly-check.ps1`, holds the reader's Windows
|
||||
calls to a committed list and refuses, on the list or off it, a call that sends to a device, injects input or reads
|
||||
a key; no other managed source and no native source may name an input function. **With no controller at hand, what
|
||||
the reader does with one connected is not established**: its tests use a Windows whose answers they write, and one
|
||||
suite runs it on the real Windows of the machine and asserts only that it opens, answers and closes.
|
||||
|
||||
### Changed
|
||||
|
||||
- **Advanced metrics is closed: the ten readings that were "being studied" are now "not read", with the reason**
|
||||
(D154, the owner's decision). What a game sets and asks through Streamline's own functions for a feature — DLSS
|
||||
frame generation's options and state, the video memory DLSS estimates for itself, the options of ray
|
||||
reconstruction, Image Scaling and Dynamic Vibrance, the PC-latency markers — is reached only by handing the game
|
||||
a function of FrameLedger's in place of Streamline's, which is refused. The *Sources* list says so, in English,
|
||||
Vietnamese and Japanese, and the guide no longer says a later release reads more. Nothing that was read stops
|
||||
being read.
|
||||
|
||||
- **The two lines of the graphics card's time say what each is, not which holds the other** (D152, the owner's
|
||||
decision). *GPU active render (idle time excluded)* and *GPU render, start to end (idle time included)* are now
|
||||
*GPU active render (the driver's own figure)* and *GPU render (between the driver's start and end marks)*, in
|
||||
English, Vietnamese and Japanese, and the guide says why: in Cyberpunk 2077 without frame generation the
|
||||
driver's active time is longer than its two marks are apart. The numbers are unchanged.
|
||||
|
||||
- **The guide's page on Advanced metrics says what two of the driver's switches mean** (`guide/12`): the latency
|
||||
report is there in a game that has Reflex built in, whether Reflex is on or off in its menu; `bUseGameSleep`
|
||||
says the game calls Reflex's sleep — NVIDIA asks for that even with Reflex off — and `bLowLatencyMode` is the
|
||||
one that says the mode is on; frame generation needs Reflex, not the reverse. From NVIDIA's Streamline guide
|
||||
for Reflex, and from the owner's ten sessions on 0.1.0-beta.49.
|
||||
|
||||
### Documentation
|
||||
|
||||
- **Owner-only item 47 was run and read** (`docs/HANDOFF.md`): in Cyberpunk 2077 without frame generation the
|
||||
driver's active GPU time is longer than its own two marks are apart on 4 917 of 5 394 frames (1 849 µs beside
|
||||
1 571 µs) and on none of 129 900 frames in five other games — the difference is the driver's; samples without a
|
||||
report are now confined to a game's start; a session with the option off has no latency line; and the stop of
|
||||
D141 fired in a real game for the first time (Kingdom Come: Deliverance II, one call of 5.3 ms while it
|
||||
started).
|
||||
- **Streamline's programming guides for Reflex and for DLSS Ray Reconstruction (2.14.16) read against the code**
|
||||
(`docs/spike-notes/30-reflex-latency.md`, *Added 2026-11-14*). Ray reconstruction was already measured the way
|
||||
the guide describes; two comments in the Overlay's source and one line of `17_HOOK_ENGINE` said super
|
||||
resolution and ray reconstruction run together, and they do not. `03_METRICS` and `05_DETECTION` no longer
|
||||
promise "PC latency as reported by Reflex" (D147). No code changed: comments only.
|
||||
|
||||
## Releases
|
||||
|
||||
Newest first. Each file holds that release's section exactly as it stood here.
|
||||
|
||||
| Version | Date | Notes |
|
||||
|---|---|---|
|
||||
| `0.1.0-beta.49` | 2026-11-14 | [`docs/changelog/0.1.0-beta.49.md`](docs/changelog/0.1.0-beta.49.md) |
|
||||
| `0.1.0-beta.48` | 2026-11-14 | [`docs/changelog/0.1.0-beta.48.md`](docs/changelog/0.1.0-beta.48.md) |
|
||||
| `0.1.0-beta.47` | 2026-11-14 | [`docs/changelog/0.1.0-beta.47.md`](docs/changelog/0.1.0-beta.47.md) |
|
||||
| `0.1.0-beta.46` | 2026-11-13 | [`docs/changelog/0.1.0-beta.46.md`](docs/changelog/0.1.0-beta.46.md) |
|
||||
| `0.1.0-beta.45` | 2026-11-12 | [`docs/changelog/0.1.0-beta.45.md`](docs/changelog/0.1.0-beta.45.md) |
|
||||
| `0.1.0-beta.44` | 2026-11-12 | [`docs/changelog/0.1.0-beta.44.md`](docs/changelog/0.1.0-beta.44.md) |
|
||||
| `0.1.0-beta.43` | 2026-11-12 | [`docs/changelog/0.1.0-beta.43.md`](docs/changelog/0.1.0-beta.43.md) |
|
||||
|
||||
@@ -20,6 +20,8 @@ A C++ DLL (`FrameLedger.Overlay.dll`) is injected into games the user explicitly
|
||||
> **Amended 2026-10-03 (owner decision D38): the evidence moved from before the grant to its trial.** "≥ 2 successful Tier-1 sessions" above could never be met by a game blocked at add time — since beta.8 that is every blocked game — nor after a ledger reset. Asked with that, the owner chose: a grant needs no session; the first two hooked sessions under it are a trial, and any end during the trial (a crash, a safety unhook, a floor stop, a new finding, or a stored hooked session with no frames or an abnormal exit) ends the exception **for good** (`games.ac_exception_trial_failed_at`, schema 0017, never cleared). Every other condition above is unchanged, and so is the last sentence.
|
||||
3. **Never implement evasion.** No manual mapping, no PE header erasure, no thread hiding, no signature obfuscation, no unlinking from the PEB module list. Injection uses documented `LoadLibraryW`. The DLL keeps its real name, real exports, and version info. A performance tool must be *visible* to anti-cheat, not hidden from it. Any PR that makes FrameLedger harder to detect is rejected on principle.
|
||||
4. **Never read or write game memory outside our own hooks.** We read arguments passed to APIs we hooked and COM/handle objects we legitimately own. No pattern scanning for game internals, no reading player/entity state, no writing to game memory. Ever.
|
||||
|
||||
> **Amended 2026-11-13 (owner decision D132): a driver's read-only getter, with the device of the swap chain we hook.** Asked with this rule quoted, the owner ruled that calling NVIDIA's two latency getters (`NvAPI_D3D_GetLatency`, `NvAPI_D3D_GetSleepStatus`) with the device behind a swap chain the Overlay hooks is inside this rule: it reads the driver's report, not game memory, and writes nothing. ~~Nothing shipped does it yet~~ **Shipped since 0.1.0-beta.47 (owner decisions D136, D138–D141)**, after the spike on `hook-harness`, a stub and the installed driver (`spike-notes` §31): only while a session records Advanced metrics (no switch of its own), about once a second on the presenting thread, through an `nvapi64.dll` the game had loaded — one in the game's own folder is refused, and a fault or a call of 2 ms or more ends it until the game exits (`17_HOOK_ENGINE` §Calls the Overlay makes into a driver). **It is the only call of its kind; another needs a ruling of the same kind.** Getters only, never a setter, a marker or a sleep, and never a call that loads `nvapi64.dll` into a game.
|
||||
5. **The hook must never crash the game.** Every hook body: SEH-guarded, allocation-free, lock-free, no logging, no exceptions crossing the boundary. On repeated faults, self-disable (`17_HOOK_ENGINE` §Fault policy).
|
||||
6. **FPS display rule (product requirement):** wherever FPS is shown and Frame Generation is active, show *Native FPS*, *Displayed FPS*, and the FG factor together (`62 → 118 FPS (×1.9 FG)`). Never a single inflated number. See `docs/03_METRICS.md`.
|
||||
|
||||
@@ -133,6 +135,18 @@ src/
|
||||
# loaded, the game switching it, its resources allocated and freed and Streamline
|
||||
# shut down, from six more calls hooked the same way (D130); slInit is not hooked
|
||||
# and its entry says why (AdvancedReach.BeforeAttach, D129).
|
||||
# Since 0.1.0-beta.47 (train C, D136-D141) also what NVIDIA's driver reports about
|
||||
# a frame's stages - NOT an argument of a hooked call: the Overlay calls two
|
||||
# read-only getters of the driver itself (reach GameDriver); seven adv.* series
|
||||
# and one table, and AdvancedDriverRead says what became of the read.
|
||||
# Since 0.1.0-beta.48 (D142-D144) also two figures the driver works out itself, of
|
||||
# the same report - no further call: an entry of their own, nvapi.reflex.gpu_times,
|
||||
# two adv.* series; and the table lists every frame-generation multiplier seen.
|
||||
# Since 0.1.0-beta.49 (D148-D151) the Overlay also counts each frame of that report
|
||||
# by its GPU span and the driver's active time - for its native log ONLY
|
||||
# (LATENCY_FRAMES, a batch per state of the sleep status; nothing published or
|
||||
# stored); its watchdog's periodic tick is on a grid (fl_watchdog_tick.h), and
|
||||
# Recording/PendingInGameReadings keeps the reading that waits for a sample.
|
||||
FrameLedger.Infrastructure/ # SQLite, shm reader, vendor APIs, injector interop, parsers,
|
||||
# and Capture/ (PR-C): ShmRingAttacher/ShmCaptureSink over the
|
||||
# reader, HeldProcessLivenessSource, TargetResolver (path only,
|
||||
@@ -189,10 +203,16 @@ tools/ # accuracy-check, changelog-check, chokepoint-che
|
||||
# agent-cost (D110, 2026-11-11: a developer tool, not a gate - what the shipped
|
||||
# Agent costs per second of session, Advanced metrics off and on),
|
||||
# nvapi-readonly-check (D108, 2026-11-11: every NVAPI call of the bridge is on
|
||||
# nvapi-allowed-calls.txt, and none there writes or identifies),
|
||||
# nvapi-allowed-calls.txt, and none there writes or identifies; since beta.47 also
|
||||
# the Overlay - no NvAPI call by name, and the only interface ids it may name are
|
||||
# the two on overlay-nvapi-allowed.txt),
|
||||
# overlay-fields-check (D116, 2026-11-12: every member of a vendor's struct the
|
||||
# Overlay reads for Advanced metrics is in fl_adv_fields.h and on
|
||||
# overlay-allowed-fields.txt; a camera's position, axes and matrices nowhere)
|
||||
# overlay-allowed-fields.txt; a camera's position, axes and matrices nowhere),
|
||||
# input-readonly-check (D155-D163, 2026-11-14: every Windows function the input reader
|
||||
# calls is declared in Infrastructure/Input/Win32Input.cs and on input-allowed-calls.txt;
|
||||
# none sends to a device, injects input or reads a key; raw input is registered for
|
||||
# joysticks and gamepads only; no native source names an input function)
|
||||
# (six names added 2026-10-04)
|
||||
# (PowerShell). This line used to name three, one of which
|
||||
# — resx-audit — ~~does not exist~~ exists since 2026-09-13 with
|
||||
@@ -203,6 +223,9 @@ tools/ # accuracy-check, changelog-check, chokepoint-che
|
||||
# (--vulkan since #140, --opengl since #141)
|
||||
# fl-probe-* -> guard, hook profile, interposer, NVAPI, process
|
||||
# stats, signer, Vulkan layer; fl-baseline-probe;
|
||||
# and fl-probe-reflex (2026-11-13, D132: the spike of Reflex route D,
|
||||
# spike-notes §31 - unshipped, with a stand-in nvapi64.dll among the stubs;
|
||||
# built from the Overlay's own fl_reflex.h since beta.47);
|
||||
# vendor-stubs/ -> fixture DLLs with the vendors' export names
|
||||
rules/detection-rules.json # engine/platform/capability + anticheat blocklist
|
||||
guide/ # the user guide (beta.12, D44): ~~eight~~ short English pages for players, embedded in the
|
||||
|
||||
+16
-4
@@ -5,7 +5,7 @@ hooking on for — and reading the graphics calls the game makes. That is why it
|
||||
resolution, the upscaler, frame generation and ray tracing apart. It is also where its limits come from. This
|
||||
page lists them in plain words; each item links to the document that has the details.
|
||||
|
||||
*Beta software: this page describes version 0.1.0-beta.45.*
|
||||
*Beta software: this page describes version 0.1.0-beta.49.*
|
||||
|
||||
## Games it will not measure
|
||||
|
||||
@@ -124,8 +124,17 @@ shown is recorded too, from outside the game. ([Capture](docs/04_CAPTURE.md))
|
||||
- **Ray tracing** is *Yes*, *No* or *N/A* — measured from the game's ray-tracing calls on Direct3D 12, and
|
||||
N/A where FrameLedger could not look. **Path tracing is never stated as a fact**: there is no API signal
|
||||
for it. You can correct any of these by hand, and your correction is labelled as yours.
|
||||
- HDR output, NVIDIA Reflex latency, the video-memory budget Windows gives a game, and shader-compilation
|
||||
stutter are **not measured yet** — they read N/A. ([Accuracy](legal/ACCURACY.md))
|
||||
- HDR output, end-to-end latency (click to screen), the video-memory budget Windows gives a game, and
|
||||
shader-compilation stutter are **not measured yet** — they read N/A. ([Accuracy](legal/ACCURACY.md))
|
||||
- **NVIDIA's own latency report** is read only with *Advanced metrics* on, only on an NVIDIA card, only in a
|
||||
Direct3D 12 game that uses NVIDIA Reflex: how long the driver says each stage of a frame took, about once a
|
||||
second. They are the driver's numbers, not FrameLedger's measurement. **The stages overlap and do not add up to
|
||||
the total**, and the graphics card's stage includes the time the card waited — in one game it is longer than the
|
||||
whole frame; the driver's own figure for the card's active time is shown beside it where the driver gives one.
|
||||
One point is one reading, drawn at the sample that carried it — up to a second after it was taken; with the
|
||||
sensor interval set above one second, some readings are not stored.
|
||||
FrameLedger asks the driver for them from inside the game; a read that is slow or faults is switched off until the game is closed, and the session says so.
|
||||
([Advanced metrics](guide/12-advanced-metrics.md))
|
||||
|
||||
## The game's memory
|
||||
|
||||
@@ -229,7 +238,10 @@ shown is recorded too, from outside the game. ([Capture](docs/04_CAPTURE.md))
|
||||
Streamline's answer for the graphics card the game asked about; which card that was is never read, so on a PC
|
||||
with two cards the row does not say. A refusal is shown by NVIDIA's own name for it
|
||||
(`eErrorFeatureNotSupported`), and it is the game that was refused, not FrameLedger. None of this says a
|
||||
feature ran or drew anything. **Not confirmed on a real game yet.**
|
||||
feature ran or drew anything. **Read on five games on 2026-11-13**: each asked whether its features are
|
||||
supported, three asked whether they are loaded, two switched features off and on, one freed a feature's
|
||||
resources once and one shut Streamline down once. **None allocated a feature's resources after FrameLedger was
|
||||
in it**, so that row has not been seen in a real game.
|
||||
- **What a game started Streamline with is not read, and will not be**: the game makes that call once, before
|
||||
FrameLedger can be inside it — also when FrameLedger starts the game itself. The Advanced page lists the entry
|
||||
with that reason.
|
||||
|
||||
@@ -13,7 +13,7 @@ app too (Help ▸ User guide, Help ▸ Limitations, Help ▸ Accessibility), and
|
||||
|
||||
<!-- accuracy-block:begin -->
|
||||
> ⚠ **What FrameLedger actually measures today — 2026-11-11.** The software is a beta; its latest
|
||||
> **beta is `0.1.0-beta.45`** (2026-11-12), an unsigned installer built from that tag with its
|
||||
> **beta is `0.1.0-beta.49`** (2026-11-14), an unsigned installer built from that tag with its
|
||||
> checksums published beside it (alphas — experimental builds that try a newer .NET — are published apart). The source holds the desktop app
|
||||
> (library, store import, charts, settings) and the background Agent, which records a session when a
|
||||
> game in the library runs (unless you switched its recording off), injects only into games you enabled
|
||||
@@ -87,8 +87,18 @@ app too (Help ▸ User guide, Help ▸ Limitations, Help ▸ Accessibility), and
|
||||
> mean, median and peak. The game's other processes (launchers, helpers) are not counted.
|
||||
> - **Video memory:** in use on the whole graphics card, recorded from Windows and GPU-driver telemetry
|
||||
> and charted. **Not measured at all:** the video-memory budget Windows gives a game, which frame
|
||||
> spikes were shader compilation, PC latency (Reflex), and HDR. Stutter count and stutter time are
|
||||
> spikes were shader compilation, end-to-end PC latency, and HDR. Stutter count and stutter time are
|
||||
> measured from frame times.
|
||||
> - **NVIDIA's latency report (only with Advanced metrics on; Direct3D 12; a game that uses NVIDIA Reflex):** how
|
||||
> long the driver says each stage of a frame took — simulation, render submit, present, driver, the operating
|
||||
> system's queue, the graphics card — read from the graphics driver about once a second and shown as the driver
|
||||
> reported it: **the driver's numbers, not a measurement by FrameLedger**, an average of the frames of one read,
|
||||
> never checked against another tool, and not the delay from a click to the screen. **The stages overlap and do
|
||||
> not add up to the total.** The graphics card's stage runs from its start to its end and includes the time the
|
||||
> card waited — in one game it was longer than the whole frame — so since beta.48 two figures the driver works
|
||||
> out itself are shown beside it: the card's active time, and the time from one frame's end to the next. A
|
||||
> driver may give neither, and then there is no line. Read in two real games, on one driver and one card
|
||||
> (2026-11-14). A game that does not use Reflex has none. The session summary's latency fields stay N/A.
|
||||
> - **Pacing, VSync and the graphics card (since beta.14):** the share of the time below 30 FPS, below 60 FPS and below
|
||||
> the monitor's refresh rate, measured from frame times with small margins so that a game held at its limit is not
|
||||
> counted as below it (a rate less than 2 % under the line reads partly as at it), and how much one frame's time
|
||||
@@ -124,9 +134,10 @@ app too (Help ▸ User guide, Help ▸ Limitations, Help ▸ Accessibility), and
|
||||
> also whether Streamline says each feature is supported and whether it is loaded, and what the game did with it
|
||||
> after FrameLedger attached — switched it on or off, allocated and freed its resources (counted to fifteen), shut
|
||||
> Streamline down: calls the game made, not a statement that a feature ran or produced anything. FSR's upscaling
|
||||
> values, Streamline's constants (six games), its answers about a feature (five games) and the
|
||||
> frame-generation configuration (one game) have been read from real games; the DLSS options and the six calls
|
||||
> of beta.45 have not been confirmed on one yet. A game may give a value in a unit of its own: one gives
|
||||
> values, Streamline's constants (seven games), its answers about a feature (seven games), the
|
||||
> frame-generation configuration (one game) and five of beta.45's six calls (five games) have been read from
|
||||
> real games; no game run so far allocated a feature's resources after FrameLedger attached, and the DLSS
|
||||
> options have not been confirmed on one yet. A game may give a value in a unit of its own: one gives
|
||||
> Streamline its field of view in degrees, and it is shown as given.
|
||||
> - **Safety:** every pre-injection check runs before injection, including the signed-by-a-known-vendor
|
||||
> half of the suspicious-module rule. During every capture the Agent re-runs the checks every 30 s and
|
||||
@@ -204,7 +215,7 @@ Elevation is **optional — for everything.** Hooked capture is the normal path
|
||||
|
||||
## Install
|
||||
|
||||
> **The latest beta is `v0.1.0-beta.45` (2026-11-12); before it `v0.1.0-beta.44` (2026-11-12), `v0.1.0-beta.43` (2026-11-12), `v0.1.0-beta.42` (2026-11-12), `v0.1.0-beta.41` (2026-11-12), `v0.1.0-beta.40` (2026-11-12), `v0.1.0-beta.39` (2026-11-11), `v0.1.0-beta.38` (2026-11-11), `v0.1.0-beta.37` (2026-11-11), `v0.1.0-beta.36` (2026-11-10), `v0.1.0-beta.35` (2026-11-09), `v0.1.0-beta.34` (2026-11-06), `v0.1.0-beta.33` (2026-11-03), `v0.1.0-beta.32` (2026-10-31), `v0.1.0-beta.31` (2026-10-26), `v0.1.0-beta.30` (2026-10-26), `v0.1.0-beta.29` (2026-10-25), `v0.1.0-beta.28` (2026-10-20), `v0.1.0-beta.27` (2026-10-20), `v0.1.0-beta.26` (2026-10-19), `v0.1.0-beta.25` (2026-10-19), `v0.1.0-beta.24` (2026-10-19), `v0.1.0-beta.23` (2026-10-14), `v0.1.0-beta.22` (2026-10-13), `v0.1.0-beta.21` (2026-10-13), `v0.1.0-beta.20` (2026-10-12), `v0.1.0-beta.19` (2026-10-12), `v0.1.0-beta.18` (2026-10-07), `v0.1.0-beta.17` (2026-10-07), `v0.1.0-beta.16` (2026-10-06), `v0.1.0-beta.15` (2026-10-06), `v0.1.0-beta.14` (2026-10-06), `v0.1.0-beta.13` (2026-10-04), `v0.1.0-beta.12` (2026-10-04), `v0.1.0-beta.11` (2026-10-03), `v0.1.0-beta.10` (2026-09-28), `v0.1.0-beta.9` (2026-09-26), `v0.1.0-beta.8` (2026-09-25), `v0.1.0-beta.7` (2026-09-23), `v0.1.0-beta.6` (2026-09-23), `v0.1.0-beta.5` (2026-09-22), `v0.1.0-beta.4` (2026-09-21), `v0.1.0-beta.3` (2026-09-21), `v0.1.0-beta.2` (2026-09-17) and `v0.1.0-beta.1` (2026-09-16).** They are pre-releases: read the notes of the one you install — `CHANGELOG.md` links each release's own file under `docs/changelog/` — for what it measures, what it does not yet, and how to update, before installing. A source build is `docs/12_BUILD.md`.
|
||||
> **The latest beta is `v0.1.0-beta.49` (2026-11-14); before it `v0.1.0-beta.48` (2026-11-14), `v0.1.0-beta.47` (2026-11-14), `v0.1.0-beta.46` (2026-11-13), `v0.1.0-beta.45` (2026-11-12), `v0.1.0-beta.44` (2026-11-12), `v0.1.0-beta.43` (2026-11-12), `v0.1.0-beta.42` (2026-11-12), `v0.1.0-beta.41` (2026-11-12), `v0.1.0-beta.40` (2026-11-12), `v0.1.0-beta.39` (2026-11-11), `v0.1.0-beta.38` (2026-11-11), `v0.1.0-beta.37` (2026-11-11), `v0.1.0-beta.36` (2026-11-10), `v0.1.0-beta.35` (2026-11-09), `v0.1.0-beta.34` (2026-11-06), `v0.1.0-beta.33` (2026-11-03), `v0.1.0-beta.32` (2026-10-31), `v0.1.0-beta.31` (2026-10-26), `v0.1.0-beta.30` (2026-10-26), `v0.1.0-beta.29` (2026-10-25), `v0.1.0-beta.28` (2026-10-20), `v0.1.0-beta.27` (2026-10-20), `v0.1.0-beta.26` (2026-10-19), `v0.1.0-beta.25` (2026-10-19), `v0.1.0-beta.24` (2026-10-19), `v0.1.0-beta.23` (2026-10-14), `v0.1.0-beta.22` (2026-10-13), `v0.1.0-beta.21` (2026-10-13), `v0.1.0-beta.20` (2026-10-12), `v0.1.0-beta.19` (2026-10-12), `v0.1.0-beta.18` (2026-10-07), `v0.1.0-beta.17` (2026-10-07), `v0.1.0-beta.16` (2026-10-06), `v0.1.0-beta.15` (2026-10-06), `v0.1.0-beta.14` (2026-10-06), `v0.1.0-beta.13` (2026-10-04), `v0.1.0-beta.12` (2026-10-04), `v0.1.0-beta.11` (2026-10-03), `v0.1.0-beta.10` (2026-09-28), `v0.1.0-beta.9` (2026-09-26), `v0.1.0-beta.8` (2026-09-25), `v0.1.0-beta.7` (2026-09-23), `v0.1.0-beta.6` (2026-09-23), `v0.1.0-beta.5` (2026-09-22), `v0.1.0-beta.4` (2026-09-21), `v0.1.0-beta.3` (2026-09-21), `v0.1.0-beta.2` (2026-09-17) and `v0.1.0-beta.1` (2026-09-16).** They are pre-releases: read the notes of the one you install — `CHANGELOG.md` links each release's own file under `docs/changelog/` — for what it measures, what it does not yet, and how to update, before installing. A source build is `docs/12_BUILD.md`.
|
||||
|
||||
1. Download the latest `FrameLedger.App-win-Setup.exe` from [Releases](https://github.com/poli0981/frameledger/releases). It installs into `%LOCALAPPDATA%\FrameLedger.App`; your data stays in `%LOCALAPPDATA%\FrameLedger`, and uninstalling asks before touching it.
|
||||
2. SmartScreen may warn — releases are not code-signed (free, open-source project). Verify the SHA-256 checksum published with each release, then **More info → Run anyway**.
|
||||
@@ -250,7 +261,7 @@ FrameLedger is GPL-3.0-only free software, and you are welcome to build it, chan
|
||||
| `FrameLedger.Overlay.dll` | Inside the game | C++20 hooks + lock-free shared-memory writer. Records only; never analyzes, allocates, or blocks |
|
||||
| `FrameLedger.VkLayer.dll` | Inside the game | Vulkan implicit layer (Vulkan titles use this instead of injection) |
|
||||
|
||||
GPU telemetry is layered so the project never depends on a proprietary vendor licence: a vendor-neutral DXGI/performance-counter baseline, LibreHardwareMonitor (MPL-2.0) for sensors on all vendors, and NVIDIA's NVAPI SDK (MIT) for NVIDIA-only extras (telemetry and the driver's DLSS record today; Reflex latency is not read yet). No Intel or AMD GPU *telemetry* SDK is bundled — see `docs/18_GPU_VENDOR_APIS.md` for why. The one AMD component in the tree is five MIT headers from the FidelityFX SDK, used for types only so the upscaler hook can read an FSR title's own dispatch descriptor; nothing AMD-built is linked or redistributed.
|
||||
GPU telemetry is layered so the project never depends on a proprietary vendor licence: a vendor-neutral DXGI/performance-counter baseline, LibreHardwareMonitor (MPL-2.0) for sensors on all vendors, and NVIDIA's NVAPI SDK (MIT) for NVIDIA-only extras (telemetry and the driver's DLSS record; and, with Advanced metrics on, the driver's own latency report, read inside a Direct3D 12 game that uses NVIDIA Reflex). No Intel or AMD GPU *telemetry* SDK is bundled — see `docs/18_GPU_VENDOR_APIS.md` for why. The one AMD component in the tree is five MIT headers from the FidelityFX SDK, used for types only so the upscaler hook can read an FSR title's own dispatch descriptor; nothing AMD-built is linked or redistributed.
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -25,8 +25,14 @@
|
||||
-->
|
||||
<Property Name="sonar.exclusions">src/native/third_party/**,**/Strings.Designer.cs,src/native/tools/hook-harness/dxr_raygen_dxil.h,src/native/tools/vendor-stubs/**,tests/fixtures/**,legal/licenses/**,docs/vendor-exports.json,src/FrameLedger.Infrastructure/Persistence/Migrations/**,build/**,out/**,**/bin/**,**/obj/**,**/TestResults/**</Property>
|
||||
|
||||
<!-- Tests repeat their arrange steps on purpose; duplication there is not a defect. -->
|
||||
<Property Name="sonar.cpd.exclusions">tests/**,src/native/tests/**</Property>
|
||||
<!--
|
||||
Tests repeat their arrange steps on purpose; duplication there is not a defect.
|
||||
HookFamilies.cs is the Domain's mirror of FlHookFamily (ShmLayout.cs): Domain references nothing, so the enum is
|
||||
written twice by design and MetricEnumMirrorTests fails when the two differ. Six members added at once
|
||||
(0.1.0-beta.45) were 39 duplicated lines of 1,063 new ones, 3.7 % against the gate's 3 %, and failed it on the
|
||||
release's commit with no issue open. The mirror is left out of the detection; FlHookFamily itself is not.
|
||||
-->
|
||||
<Property Name="sonar.cpd.exclusions">tests/**,src/native/tests/**,src/FrameLedger.Domain/Metrics/HookFamilies.cs</Property>
|
||||
|
||||
<Property Name="sonar.sourceEncoding">UTF-8</Property>
|
||||
|
||||
|
||||
@@ -499,6 +499,15 @@ function Invoke-ProjectGates {
|
||||
Invoke-Checked 'overlay-fields-check (self-test)' { & $fieldsTool -SelfTest }
|
||||
Invoke-Checked 'overlay-fields-check' { & $fieldsTool -RepoRoot $repo }
|
||||
|
||||
# 2026-11-14 (D155-D163): what is asked of Windows about controllers, the keyboard and the mouse. The reader's
|
||||
# calls are declared in one file and held to tools/input-allowed-calls.txt in both directions; a call that sends to
|
||||
# a device, injects input or reads a key is red even when the list names it; no managed source outside the reader
|
||||
# and no native source names an input function; raw input is registered for joysticks and gamepads only. Text only.
|
||||
Write-Step 'input-readonly-check'
|
||||
$inputTool = Join-Path $repo 'tools/input-readonly-check.ps1'
|
||||
Invoke-Checked 'input-readonly-check (self-test)' { & $inputTool -SelfTest }
|
||||
Invoke-Checked 'input-readonly-check' { & $inputTool -RepoRoot $repo }
|
||||
|
||||
Write-Step 'docs-split-check'
|
||||
$splitTool = Join-Path $repo 'tools/docs-split-check.ps1'
|
||||
Invoke-Checked 'docs-split-check (self-test)' { & $splitTool -SelfTest }
|
||||
|
||||
+56
-2
@@ -36,7 +36,7 @@ Let `D` = session duration (first → last present), `F_app` = frames the *game*
|
||||
| **Frametime σ** | population stddev of `ft_app` (ms) | 1 |
|
||||
| **Stutter count** | `ft_app[i] > 2 × rollingMedian(ft_app, 19)` (centered, window in **frames**) | 1 |
|
||||
| **Stutter time %** | `Σ ft_app[stutter] / Σ ft_app × 100` | 1 |
|
||||
| **PC latency** | mean/p95 of `reflexLatencyUs` when Reflex reports it | **1 only** |
|
||||
| **PC latency** | mean/p95 of `reflexLatencyUs` when Reflex reports it *(nothing fills `reflexLatencyUs`: a report arrives after its frame's record is written. Since train C, 2026-11-13, the driver's stage report is read as seven Advanced series beside the frames — `18_GPU_VENDOR_APIS` §The inventory — and these session fields stay N/A; asked again on 2026-11-14 with two real games read, the owner kept them N/A (D147): the driver's total runs from simulation start to the graphics card's end, not from an input to the display)* | **1 only** |
|
||||
| **PSO stutter %** | share of stutter frames with `psoCreatedThisFrame > 0` | **1 only** |
|
||||
| **Time below 30 / 60 FPS** (beta.14) | share of `Σ ft_app` in frames that count as below X — `ft > 1.10 × 1000/X`, or the nine-frame rolling median `> 1.02 × 1000/X` (§Pacing) | 1 |
|
||||
| **Time below refresh** (beta.14) | the same over **presents**, X = `display_monitor_hz` — the display's rate, so over what the display received | 1 |
|
||||
@@ -976,6 +976,60 @@ min / max in `sensor_stats_json` (§Sensor aggregates). MiB stored; shown in GB
|
||||
|
||||
~~`vramUsedMb` from `IDXGIAdapter3::QueryVideoMemoryInfo(LOCAL)` inside the game = **this game's** usage and budget. **MiB, truncating, and it must use the same divisor as `vramBudgetMb`** — the two are compared, and mismatched rounding would put a systematic bias into `budget_exceeded_pct`. Residual: a flip within 1 MiB of the budget, 0.004% of a 24 GiB card. Stored as its own series and clearly labelled apart from the adapter-wide figure from `18_GPU_VENDOR_APIS`. Aggregates: avg, max, and `budget_exceeded_pct` (share of samples where `CurrentUsage > Budget`, i.e. the driver was likely evicting — a genuinely useful stutter explanation).~~
|
||||
|
||||
## Input — what a session was played with, both tiers (owner decisions D155–D163)
|
||||
|
||||
**Owner request, 2026-11-14:** the share of a session played with a controller and with the keyboard, how often a
|
||||
controller connected and dropped, the battery state that lasted longest, the switches between makers' controllers.
|
||||
What is read and what never is: [`21_INPUT_DEVICES.md`](21_INPUT_DEVICES.md). The arithmetic is
|
||||
`Domain.Input` and `Application.Recording.InputSessionBuilder`. **Not built end to end yet** — nothing reads a device
|
||||
until the pull requests after the one that wrote this section; until then these are definitions under test.
|
||||
|
||||
**What it can say, and what it cannot.** Everything is read from outside the game. So a number here says that a
|
||||
controller, or the keyboard or mouse, was *in use while the game's window was in front* — never what the game did with
|
||||
it, and never which button or key.
|
||||
|
||||
**The unit is a slice** of about a tenth of a second, and a slice counts for a session only when a window of the
|
||||
session's game was in front and the session was not paused (a pause is a gap, as for frames). A slice with another
|
||||
program in front is not classified: typing in a browser beside the game is not the game played with the keyboard.
|
||||
|
||||
| Class | A slice in front in which |
|
||||
|---|---|
|
||||
| Controller | a controller was in use and the time of the last keyboard-or-mouse input did not move |
|
||||
| Keyboard & mouse | that time moved and no controller was in use. One class: only a time is read (D158) |
|
||||
| Both | both |
|
||||
| No input | neither |
|
||||
|
||||
- **A controller is in use** when a button is down, a trigger is past its threshold, or a stick is outside its dead
|
||||
zone. A stick held counts. One that drifts inside the dead zone does not — a pad lying on a desk is not played with.
|
||||
- **A share** is a class's time over the time the game was in front (`input_foreground_ms`). The four add up to it.
|
||||
- **A switch of method** is a change between *controller* and *keyboard & mouse* from one tick (a second) to a later
|
||||
one. A tick played with both, or with neither, is no one thing and does not end the run before it: putting the
|
||||
controller down and picking it up again is not a switch.
|
||||
- **Connections** are counted from the session's second slice: a controller that is there when the session starts has
|
||||
not connected. A Bluetooth pad that goes to sleep has disconnected.
|
||||
- **A battery** is timed by the clock, in front or not: the time at each level, the level that lasted longest, the
|
||||
first and the last. Each source keeps its own steps — XInput's four words, a DualSense's per cent in tens — and none
|
||||
is converted into another's. **A rate**, in per cent an hour, is the fall from the first to the last reading on
|
||||
battery over the time read on battery; it is given only for a level in per cent that fell, was not put on power in
|
||||
between, and was read on battery for ten minutes or more.
|
||||
- **A maker's share** is the time its controllers were in use over that time for every maker. **A switch of maker**
|
||||
is counted like a switch of method, between ticks in which one maker's controllers alone were in use.
|
||||
- **One pad seen twice is one controller.** With Steam Input in front of a controller Windows shows the controller the
|
||||
player holds and an Xbox pad Steam presents for it. One of XInput's pads that was in use at the same moments as
|
||||
another controller — nine tenths of the busier one's time, over ten seconds or more — is folded into it: into a
|
||||
controller that is not XInput's at any time, into another of XInput's pads only in a session in which Steam's
|
||||
virtual gamepad was seen. Two players pressing in step are two players.
|
||||
|
||||
**The timeline** is one series, `input.class`: what each tick was mostly played with, as the class's number (0 no
|
||||
input, 1 controller, 2 keyboard & mouse, 3 both), and no value for a tick with the game not in front. Each of the
|
||||
first eight controllers has `input.dev.N.active` (the part of the tick's time in front it was in use; no value where
|
||||
it was not connected) and, with a battery that has a level, `input.dev.N.battery`.
|
||||
|
||||
**Known limits.** Keyboard and mouse cannot be told apart. Input a program injects counts as keyboard and mouse — Steam
|
||||
Input mapping a pad to keys, a macro tool — so a pad mapped that way reads as *both*. A game whose window belongs to
|
||||
another process reads as never in front (the focus sample's limit). Whether a controller's own input moves Windows'
|
||||
last-input time has not been checked on a real PC.
|
||||
|
||||
## Sensor aggregates
|
||||
|
||||
Per session over 1 Hz samples: `avg` (mean of non-null), `max` — and since beta.12 the `median` (the linear-interpolation
|
||||
@@ -1019,7 +1073,7 @@ processor's, not the whole PC's — averaged over the session's sensor ticks. `D
|
||||
| RT active | measured per frame | not available |
|
||||
| Path tracing | heuristic, confidence-scored, never asserted | not available |
|
||||
| ~~Per-process VRAM~~ Game process memory (beta.12) | ~~exact~~ dedicated / shared GPU memory as Task Manager counts it — a known 512 MiB allocation read +512.0 MiB (`spike-notes` §16); private working set equal to Windows' own counter; read from outside the game | ~~not available~~ the same, from outside; an unpinned hold sums the executable's processes |
|
||||
| PC latency | as reported by Reflex | not available |
|
||||
| PC latency | ~~as reported by Reflex~~ **not available** (D147, *corrected 2026-11-14*): the driver's report ends at the end of the GPU's work, not at the display. The stages it does give are Advanced metrics — the driver's numbers, unchecked | not available |
|
||||
| Display mode (beta.10) | per 100 ms sample: exclusive fullscreen as the swap chain answers it (DXGI; OpenGL and Vulkan cannot say), borderless, windowed, minimised; the window's size from user32 | per 1 s sample, from the window alone: windowed, minimised, or *fullscreen or borderless* — never split |
|
||||
| GPU temp / load / power | vendor API accuracy, ±1 s sampling | same |
|
||||
| GPU clocks / fan / memory temperature (beta.14) | vendor API accuracy, ±1 s sampling | same |
|
||||
|
||||
@@ -22,8 +22,8 @@ Derived in the Agent from the record stream; the mapping is in `03_METRICS`. Sum
|
||||
| Render resolution vs output resolution (incl. mid-session changes) | upscaler parameter reads + `ResizeBuffers` |
|
||||
| Frame Generation mode + factor | NGX/SL/FFX FG feature evaluation, then cadence — **Tier 1 only**. ~~then (Tier 2 only) PresentMon `FrameType`~~ retired (§S31 row P2), and Tier 2 no longer produces frames to run cadence over either |
|
||||
| Ray Tracing active | AS builds + `DispatchRays` (both, to catch inline RayQuery) |
|
||||
| Ray Reconstruction | NGX `RayReconstruction` feature evaluated |
|
||||
| Reflex on + PC latency | NVAPI Reflex hooks |
|
||||
| Ray Reconstruction | ~~NGX `RayReconstruction` feature evaluated~~ Streamline's `slEvaluateFeature(kFeatureDLSS_RR)` — it runs **instead of** super resolution, in DLSS's own quality mode (Streamline's guide; measured 2026-08-15), so the upscaler is DLSS and this is a yes/no beside it. A game that calls NGX directly reads N/A (`03_METRICS` §RT/PT/RR) *(corrected 2026-11-14)* |
|
||||
| ~~Reflex on + PC latency~~ The driver's latency report and sleep status (0.1.0-beta.47, Advanced metrics only) | ~~NVAPI Reflex hooks~~ two read-only getters of the driver, called by the Overlay (`17_HOOK_ENGINE` §Calls the Overlay makes into a driver). **PC latency — input to display — is not read** (D147): the report ends where the GPU's work ends, and NVIDIA's own figure is taken from outside the game (`spike-notes` §30, route E) *(corrected 2026-11-14)* |
|
||||
| Per-process VRAM | `QueryVideoMemoryInfo` |
|
||||
| PSO compilation events | pipeline-creation hooks |
|
||||
| Display mode — exclusive fullscreen / borderless / windowed / minimised, with the window, back buffer and monitor (beta.10) | `GetFullscreenState` + `GetDesc` polled on the presenting chain (≤ 2 Hz, shared-memory region 4), and the window's geometry read by the Agent **out of process** — so this row is **both tiers**: a Tier-2 session has the window alone, and never splits exclusive from borderless (`03_METRICS` §Display mode) |
|
||||
|
||||
+78
-1
@@ -342,7 +342,25 @@ CREATE TABLE sessions (
|
||||
display_source TEXT, -- swapchain | opengl | window: the strongest witness any sample had
|
||||
display_window_w INTEGER, display_window_h INTEGER, -- client area, in the mode that lasted longest (the last seen, beta.27)
|
||||
display_buffer_w INTEGER, display_buffer_h INTEGER, -- the swap chain's back buffer, same mode
|
||||
display_monitor_w INTEGER, display_monitor_h INTEGER, display_monitor_hz INTEGER
|
||||
display_monitor_w INTEGER, display_monitor_h INTEGER, display_monitor_hz INTEGER,
|
||||
|
||||
-- schema 0024 (2026-11-14, beta.50, D155-D163): what the session was played with, both tiers (03_METRICS §Input) -
|
||||
-- read by the Agent from outside the game. Milliseconds. NULL before, with the option off, and before the terms
|
||||
-- that describe the reading were accepted - N/A, never 0. From the samples, so a recovered session has them.
|
||||
input_observed_ms INTEGER, -- the reader ran and the session was not paused
|
||||
input_foreground_ms INTEGER, -- of it, a window of the game was in front: the four below add up to this
|
||||
input_controller_ms INTEGER, -- a controller in use, the keyboard and mouse not
|
||||
input_km_ms INTEGER, -- the keyboard or mouse in use (one class - only a time is read), no controller
|
||||
input_both_ms INTEGER,
|
||||
input_idle_ms INTEGER, -- no input at all
|
||||
input_method_switches INTEGER, -- changes between a controller and the keyboard and mouse
|
||||
input_source TEXT, -- the sources that answered: rawinput, xinput, lastinput, joined by +
|
||||
input_devices TEXT -- InputDevicesRecord's JSON: {"V":1,"Devices":[{"Index","Family","VendorId",
|
||||
-- "ProductId","Model","Connection","XInputSlot","Virtual","Remapped",
|
||||
-- "ConnectedMs","ActiveMs","Connects","Disconnects","Battery":{"Scale",
|
||||
-- "States":[{"State","Level","Ms"}],"First","Last","DrainPercentPerHour"}}],
|
||||
-- "Families":[{"Family","ActiveMs","Share"}],"FamilySwitches","VirtualPad",
|
||||
-- "Health":{...counts...}} - no serial number, no address, no path
|
||||
);
|
||||
CREATE INDEX ix_sessions_game_started ON sessions(game_id, started_at DESC);
|
||||
|
||||
@@ -402,6 +420,12 @@ CREATE TABLE sensor_blobs (
|
||||
-- since schema 0023 (2026-11-11, D102) also the ADVANCED series, every one under a name
|
||||
-- that starts with `adv.` (Application.Advanced.AdvancedMetricCatalog): NaN, not -1,
|
||||
-- for a tick with no reading, and read by FindAdvancedSensorsAsync only
|
||||
-- since schema 0024 (2026-11-14, D155-D163) also the INPUT series, every one under a
|
||||
-- name that starts with `input.`: input.class (what the tick was mostly played with:
|
||||
-- 0 no input, 1 controller, 2 keyboard and mouse, 3 both), input.dev.N.active (the
|
||||
-- part of the tick's time in front controller N was in use, 0-1) and
|
||||
-- input.dev.N.battery (its level, in its own scale) - NaN for a tick with nothing to
|
||||
-- say, and read by FindInputSensorsAsync only
|
||||
-- cpu_load / ram_mb / cpu_temp and sessions.avg_cpu_load, avg_cpu_temp, max_cpu_temp,
|
||||
-- avg_ram_mb were in schema 0001 with NO producer until 2026-09-21 (Telemetry.SystemTelemetrySource
|
||||
-- on the poller's tick). Rows before that date hold NULL, which is what they measured; no migration.
|
||||
@@ -496,6 +520,27 @@ Because Tier-1 and Tier-2 sessions carry different fields, every query that comp
|
||||
> Sensor series are aligned to `t_ms` (milliseconds from `qpc_epoch`) and a tick with no reading is stored as
|
||||
> **−1** — never 0, which would be a reading — because temperatures, loads, power and memory are never negative.
|
||||
>
|
||||
> **A reading taken inside a game stands at the sample that carried it** (0.1.0-beta.49, owner decision D150): the
|
||||
> Overlay publishes about once a second and the Agent samples exactly once a second, so a publication waits for
|
||||
> the next sample — two may wait, the older is carried first (`PendingInGameReadings`). An `adv.*` point that
|
||||
> came from a game can therefore stand up to a second after its read; a tick with nothing waiting is NaN.
|
||||
>
|
||||
> **`t_ms` is the time axis; `hz` is the fallback** (written here 2026-11-14, owner decision D146 — the code cited
|
||||
> this rule before the page had it). Every series of a session is stored beside `t_ms`, which carries each
|
||||
> sample's own time, and the App draws against it; `hz` is read only for a row that has no `t_ms`
|
||||
> (`SessionSeriesLoader`). **Until 0.1.0-beta.48 `hz` was the constant 1**, whatever the samples did — and they
|
||||
> were not one second apart: the poller waited its whole interval *after* a poll's work. In the owner's ledger of
|
||||
> 2026-11-14, under a setting of 1000 ms, 180 of the 186 sessions long enough to tell have a median of 1.32 s
|
||||
> between samples; six have 1.0 s. **What takes the third of a second is not established.** Unelevated — the layers
|
||||
> composed as the Agent composes them, each read under a stopwatch — a poll takes about a millisecond. The two
|
||||
> sessions with no `cpu_temp` series (an Agent that was not elevated) are among the six, which points at the
|
||||
> sensor library's processor update, run on the poll's thread as administrator with PawnIO; but four sessions
|
||||
> that have the series kept one second, and the call itself was not timed (it needs elevation). Since 0.1.0-beta.48 the poller keeps a fixed period
|
||||
> (`TelemetryPoller.UntilNextTick`) and `hz` is the rate the session's samples had, measured from the samples
|
||||
> (`SessionFinalizer.SampleRate`: the gaps between the first and the last over the time between them, to a
|
||||
> thousandth; 1 for fewer than two) — so it is right for a session recovered from a `.partial` file as well.
|
||||
> Rows written before keep their 1.
|
||||
>
|
||||
> **The advanced series are the exception, and say so by their name (schema 0023, owner decision D102).** A series
|
||||
> whose name starts with `adv.` stores **NaN** for a tick with no reading: a motherboard's −12 V rail is negative, so
|
||||
> −1 cannot mark a gap, and most of its ticks are gaps — the sensor library is read every fifth. They go through a
|
||||
@@ -507,6 +552,15 @@ Because Tier-1 and Tier-2 sessions carry different fields, every query that comp
|
||||
> (`AdvancedSessionBuilder.MaxSeries`); what is beyond is counted in its directory, not stored.
|
||||
> **Size, measured 2026-11-11** on values shaped like the dev box's reader (17 series with a reading every tick, 41
|
||||
> with one every fifth): one hour is 816 KiB raw and **189 KiB stored** — well inside NFR-5's 3 MB an hour.
|
||||
>
|
||||
> **The input series follow the same rule under their own name (schema 0024, owner decisions D155–D163).** A series
|
||||
> whose name starts with `input.` stores NaN for a tick with nothing to say — the game was not in front, the
|
||||
> controller was not connected, the tick carried no reading — through the same sparse encoder. `FindSensorsAsync`
|
||||
> leaves them out as well (`series NOT LIKE 'input.%'`): a class's number is not a sensor's value, and the sensors'
|
||||
> statistics and chart would take it for one. `FindInputSensorsAsync` returns them with `t_ms` first. A session
|
||||
> stores `input.class` and, for each of its first eight controllers (`InputSessionBuilder.MaxDevices`),
|
||||
> `input.dev.N.active` and — where the battery has a level — `input.dev.N.battery`: at most seventeen, a few KiB an
|
||||
> hour stored.
|
||||
|
||||
## The `.partial` file
|
||||
|
||||
@@ -531,6 +585,7 @@ Because Tier-1 and Tier-2 sessions carry different fields, every query that comp
|
||||
> | 8 `SensorsWide` | the same samples under a 32-bit presence mask that carries the game process's memory (D43) | each flush, since beta.12 *(row added 2026-10-04)* |
|
||||
> | 9 `SensorsAdvanced` | the advanced readings of the samples of the type-8 chunk before it (D101): `u16` names, then per name `u16` bytes and UTF-8; `u32` samples, then per sample `i64` QPC, `u16` readings and per reading `u16` name, `f64` value. Each chunk carries its own names, so it reads without any earlier chunk | each flush **in which a sample carries any** — with Advanced metrics off, never; the file is then byte for byte what it was (2026-11-11) |
|
||||
> | 10 `AdvancedContext` | UTF-8 JSON (`AdvancedJson.OfContext`): the PC's facts, the session's, its series' directory, each source's state; the last one wins | the first flush after the recorder set it, and again only when it changed (2026-11-11) |
|
||||
> | 11 `SensorsInput` | the input readings of the samples of the type-8 chunk before it (D155–D163, `InputSampleCodec`): `u32` samples, then per sample `i64` QPC, seven `i32` (span, observed, in front, controller, keyboard and mouse, both, no input), `u8` flags, the reader's health (`u8` answers, six `i64` counts, `i32` faults), `u8` controllers and 23 bytes a controller — what it is (maker, the two USB ids, connection, XInput pad) and its part of the tick (connected, time in use, battery, connections, drops). Each sample describes every controller it counts, so a chunk reads without any earlier one | each flush **in which a sample carries one** — with the option off, never; the file is then byte for byte what it was (2026-11-14) |
|
||||
>
|
||||
> **A chunk of a type the reader does not know is skipped, not the end of the file (owner decision D106,
|
||||
> 2026-11-11).** Its length and checksum have been verified by then, so it is a whole chunk a newer build wrote.
|
||||
@@ -781,6 +836,28 @@ Sequential embedded SQL (`Migrations/0001_init.sql`, `0002_*.sql`, …), applied
|
||||
> **Nothing produces a row yet**: the option that switches the reader on is the next pull request's.
|
||||
> **A beta.38 cannot open a ledger a later build migrated.**
|
||||
|
||||
> **`0024_input_devices.sql` (0.1.0-beta.50, 2026-11-14, owner decisions D155–D163) — what a session was played
|
||||
> with, and what a store lists.** ADD COLUMN only, twelve columns. **Nine on `sessions`**: `input_observed_ms`,
|
||||
> `input_foreground_ms` and the four classes that add up to it (`input_controller_ms`, `input_km_ms`,
|
||||
> `input_both_ms`, `input_idle_ms`), `input_method_switches`, `input_source`, and `input_devices` — the session's
|
||||
> controllers as `Application.Recording.InputDevicesRecord`'s JSON (`03_METRICS` §Input). **On `sessions` and not in
|
||||
> a table of their own, on purpose** (D160) — the opposite of 0023's choice, for the opposite reason: the trend and
|
||||
> the comparison read a session's row, and these numbers are meant to be in the JSON export and the bug bundle,
|
||||
> which carry the whole row; the Privacy Policy's §3A says so. What may never be a column or a key of that JSON: a
|
||||
> controller's serial number, its Bluetooth address, its device path
|
||||
> (`LedgerDatabaseTests.ScriptTwentyFourOnlyAddsColumnsAndNamesNoIdentifier`,
|
||||
> `InputSessionBuilderTests.TheStoredJsonHasNoKeyThatCouldCarryASerialNumberAnAddressOrAPath`). **Three on
|
||||
> `games`**: `controller_support` (`full`, `partial`, or `none` for a game the store knows and lists no support
|
||||
> for), `controller_support_source` (`steam-appinfo`) and `controller_support_at` — the store's own word, from its
|
||||
> file on the disk, never a verdict of FrameLedger's (D163). Written by `SessionFinalizer.Build` from the session's
|
||||
> samples, before the tier branch — both tiers, and a session recovered from its crash file, which carries the
|
||||
> readings in chunk 11. NULL before; with the option off; before the terms that describe the reading were accepted
|
||||
> (D156); on a game no store file describes. The series are `sensor_blobs` rows named `input.*` (§Blob encoding).
|
||||
> `LatestVersion` is 24; `LedgerDatabaseTests.ScriptTwentyFourAddsTheInputColumnsAndAnEarlierSessionAndGameHaveNone`,
|
||||
> the repository round trip. **Nothing produces a reading yet, and nothing writes the three `games` columns yet**:
|
||||
> the reader, the switch and the store file are the pull requests after this one.
|
||||
> **A beta.49 cannot open a ledger a later build migrated.**
|
||||
|
||||
> **`0022_dlss_nr.sql` (beta.34, 2026-11-06, owner decision D84) — DLSS 5's neural rendering, measured.** One REAL column,
|
||||
> ADD COLUMN only: `dlss_nr_pct`, the share (0–100) of the presents that drained a Streamline evaluation on which the game
|
||||
> evaluated `kFeatureDLSS_NR` (`Domain.Metrics.NeuralRendering`). Written by the recorder's aggregation
|
||||
|
||||
+46
-2
@@ -117,8 +117,27 @@ What the region is, as a contract between the two sides:
|
||||
(`FlAdvancedState.request`, the word that was `reserved0`). The reader returns only a publication that names the
|
||||
value it wrote: what a second session of the same game finds in the region before the first tick is the first
|
||||
session's, and is not read. After an "off" the region keeps its last publication, untouched.
|
||||
- **One writer, once a second.** The detours keep process-local accumulators; the watchdog copies them here at its
|
||||
tick. No game thread writes the region, so the seqlock has a single writer: `seq` odd, the fields, `seq` even.
|
||||
- **One writer, once a second — on a grid since 0.1.0-beta.49 (owner decision D150).** The detours keep
|
||||
process-local accumulators; the watchdog copies them here at its **periodic** tick, one a second by the
|
||||
performance counter (`fl_watchdog_tick.h`). Until then it published at *every* tick, and a tick was a second
|
||||
and its own work after the one before — or at once, whenever the LoadLibrary detour woke the thread. So a
|
||||
session's publications fell behind the Agent's samples a little with every tick, and a woken tick's publication
|
||||
took the driver read with it and armed none: the publication after it was empty (0.4 to 16 % of a session's
|
||||
samples carried no report, HANDOFF item 46; under a loader that never stops, 35 720 publications in eight
|
||||
seconds and nine reads). A tick woken early still follows the request, installs and takes the census; it writes
|
||||
nothing here. **A request first seen on a woken tick is published by the periodic tick that follows, however
|
||||
soon that is**: a session's first publication may hold a moment's worth — one dispatch of a range that has two
|
||||
ends — and every one after it a second's. A reader takes ranges and "seen" words as *since the request*, which
|
||||
they are, and never reads a single publication as complete. No game thread writes the region, so the seqlock has a single writer: `seq` odd, the fields,
|
||||
`seq` even.
|
||||
- **A publication waits for a sample, and is not replaced while it waits** (0.1.0-beta.49, owner decision D150;
|
||||
the Agent's half). `SessionRecorder` looks at the region and at the telemetry poller about ten times a second
|
||||
and attaches a publication's readings to the newest sample it drains. It used to keep one set and overwrite it:
|
||||
a publication that landed just after a sample left that sample without a report, and at the next change of
|
||||
step the set that had waited was overwritten — one sample in five for minutes in the owner's session 223. Two
|
||||
sets now wait, the older is carried first (`PendingInGameReadings`): a session lacks a report at one sample at
|
||||
most when the two fall out of step, and loses no reading after it. With the sensor interval above a second
|
||||
more publications arrive than samples and the oldest is pushed out, as before.
|
||||
- **The reader keeps its last consistent copy** (`ShmRingReader.AdvancedState`): null until something was published
|
||||
for its request;
|
||||
the same copy while `seq` has not moved, without copying 1472 bytes again; and that copy still when the writer is
|
||||
@@ -165,6 +184,31 @@ What the region is, as a contract between the two sides:
|
||||
counts `slShutdown` calls, with `FL_ADV_VALID_SL_SHUTDOWN` (bit 6 of the mask) set once one was seen. All three
|
||||
are a session's and a new request clears them. `FL_HOOK_SL_ALLOCATE_RESOURCES` (bit 20),
|
||||
`FL_HOOK_SL_FREE_RESOURCES` (21) and `FL_HOOK_SL_SHUTDOWN` (22) are published with their patches.
|
||||
- **Reflex latency words (train C; written by the Overlay since 0.1.0-beta.47; owner decisions D136, D138).** The
|
||||
ten reserved words that ended the first line (@24..63) are `latState`, `latReads`, `latFrames` and seven sums:
|
||||
simulation, render submit, present, driver, OS render queue, GPU render, and the total from simulation start to
|
||||
GPU render end. **The layout is still 5**: no offset and no size moved, and the handshake's build id refuses a
|
||||
mismatched pair before either side reads the other. Unlike every other group here they are **not what the game
|
||||
passed to a call the Overlay hooks**: the Overlay makes a call of its own, about once a second, on the presenting
|
||||
thread, to the driver's two read-only getters, through an `nvapi64.dll` the game had already loaded
|
||||
(`17_HOOK_ENGINE` §Memory / latency). `latState`'s low byte is a `FlLatencyState` — no device, no module, refused
|
||||
(a module in the executable's own folder, D140), no getter, reading, error, slow (D141), faulted, stalled — and
|
||||
above it the driver's sleep status as switches *seen on* and *seen off* and the last frame-generation multiplier.
|
||||
`latFrames` and the sums are **of the newest read not yet published** — zero when no read was made since the
|
||||
publication before — so a reader divides one publication's sum by its frames and never adds publications up. A
|
||||
sum of all ones is a span some summed frame did not report. `FL_ADV_VALID_LATENCY` (bit 7 of the mask) is set once
|
||||
a read returned OK for the request; it is not one of "the game's calls were read", and `latState` is published
|
||||
whether or not it is set.
|
||||
- **Four more latency words (0.1.0-beta.48; owner decisions D142, D144).** The first line was full, so they are
|
||||
four of the seven reserved words that ended the `sl::DLSSOptions` line (@100..115; three remain, @116..127) —
|
||||
nothing of DLSS's, and **the layout is still 5** for the same reasons. `latGpuActiveSumUs` and `latGpuFrameSumUs`
|
||||
are the two times the driver works out itself — the graphics card's render time *excluding the idles in
|
||||
between* (`gpuActiveRenderTimeUs`) and one frame's GPU end to the next's (`gpuFrameTimeUs`) — summed over the
|
||||
frames of the newest read that gave one; `latGpuCounts` holds how many did, the first in its low half and the
|
||||
second in its high half, because a frame can give one and not the other. A frame that gives zero (an older
|
||||
driver leaves both zero) or more than a second is in neither the sum nor the count, and is still summed for the
|
||||
seven spans. `latMultipliersSeen` is the session's: bit n is set once the sleep status gave frame-generation
|
||||
multiplier n since the request, bit 31 standing for 31 and more; `latState` still carries the last one.
|
||||
- The Vulkan layer never writes it. `ShmLayoutMirrorTests.TheAdvancedStateMirrorMatches` checks every member's
|
||||
offset against `fl-layout-dump`; `ShmRingReaderTests` the three reads and that the request is stored either way.
|
||||
|
||||
|
||||
@@ -35,6 +35,7 @@ Targets:
|
||||
- `hook-harness` → the dummy **D3D11 + D3D12** app, WARP + composition swapchain so it runs headless on CI (`17_HOOK_ENGINE` §Test harness). D3D12 is device → command queue → swapchain, which is the acquisition asymmetry a D3D11-only fixture cannot exercise. ~~Vulkan and OpenGL modes to follow as those hooks land.~~ **`--vulkan --hold-presenting N` since 2026-09-06 (P1 item 3):** a real swapchain on a hidden window through the real loader, reached by `LoadLibraryW("vulkan-1.dll")` so only the vendored headers are needed and CI (no loader) still builds it; exit 77 = cannot run here, which the ctest reads as SKIP. **`--opengl --hold-presenting N` since the same day (P1 item 4):** a real context on a hidden window, `SwapBuffers`'d through gdi32 as a title does, on Microsoft's generic renderer — so it runs on CI.
|
||||
- `fl-probe-hookprofile` → build-profile probes for `/guard:cf` and `-D_HAS_EXCEPTIONS=0` (`20_OPEN_QUESTIONS` §H1/§H3)
|
||||
- `fl-probe-guard` → measures the Windows APIs the guard is built on, unelevated (`spike-notes.md` §1). Not the guard, and takes no injection rights.
|
||||
- `fl-probe-reflex` → the instrument of `spike-notes` §31 (2026-11-13, owner decision D132) — **since the owner said go (D136) it is built from the Overlay's own header, `FrameLedger.Overlay/include/fl_reflex.h`**, so its ctest runs the shipped call sequence with Control Flow Guard enforced; its `--real` also prints which image the two getter addresses lie in (`nvapi64_impl.dll`, not the `nvapi64.dll` that is asked). What it was written as: the call sequence Reflex route D would put into the Overlay — find `nvapi64.dll` only if the process already holds it, resolve the driver's two getters by interface id, call them — in an unshipped probe built with the Overlay's flags. `--stub` runs it against `fl_stub_nvapi64` → `nvapi64.dll` (a stand-in with knobs for a missing getter, an empty report, an error and a call that does not return; its outputs in a directory of their own, so that its `nvapi64.lib` is never beside the vendored one's name) and is ctest `fl_reflex_probe_stub`; `--real` runs it against the installed driver on an NVIDIA adapter, with the probe setting the latency markers a game would, in its own process — a measurement, never a test. It takes the vendored NVAPI headers' include directory and **does not link `nvapi64.lib`**. Nothing shipped includes its header.
|
||||
- `fl_stub_sl_interposer` → `sl.interposer.dll`, and `fl_stub_sl_common` → `sl.common.dll` (`src/native/tools/vendor-stubs/`). **Fixtures, never shipped**, built under `FL_BUILD_TOOLS`; nothing `12_BUILD` publishes references them. They export the **measured** vendor names from `docs/vendor-exports.json` so the Overlay's symbol resolution is observable, and the second is a **decoy** exporting the same name from a different module — without it, "we resolve module-scoped" is a property no test can falsify. Their **output filenames are the vendor's and their version blocks are ours**: `fl_add_version_resource` takes the real filename so a file called `sl.interposer.dll` in our build tree still says plainly that it is FrameLedger's, which `19_SAFETY` requires of everything we build.
|
||||
- `fl_stub_ffx_dx12` → `amd_fidelityfx_dx12.dll`, `fl_stub_ffx_upscaler` → `amd_fidelityfx_upscaler_dx12.dll`, `fl_stub_ffx_fg` → `amd_fidelityfx_framegeneration_dx12.dll` — the three AMD **leaves** — and `fl_stub_ffx_loader` → `amd_fidelityfx_loader_dx12.dll`, a **forwarding stand-in** bound to the two 2.x leaves through their FrameLedger-named *direct* entry — the way the real loader was measured to bypass the leaves' exports — so `--hold-presenting-ffx` can push every dispatch through a loader that is hooked along with the leaves and prove the count reads 1× (2026-09-04). Same rules as the Streamline stubs: fixtures, never shipped, vendor filenames with our version blocks. `fl_stub_ffx_fsr3_host` → `ffx_fsr3_x64.dll` (2026-09-05): the FSR 3.0 **host** facade, exporting the four names `SpeaksFsr3Host` probes for through the vendored `fsr3-v3.0.4` header's own `FFX_API`; `--ffx-topology fsr3host|fsr3host+mono` drives it, and `hookinventory-check` Pass C reads it as the export parser's second positive control.
|
||||
- **`fl_fidelityfx_headers`** → an INTERFACE target over the five vendored FidelityFX ffx-api headers (`src/native/third_party/fidelityfx/`, tag v2.3.0, MIT by exception). Three include directories because upstream's headers include each other by relative path; include directories only and nothing to link — no `.lib` is vendored — and `hookinventory-check` Pass C reads the Overlay's export table because `ffx_api.h` declares its entry points `__declspec(dllexport)` unconditionally.
|
||||
@@ -410,6 +411,7 @@ Seven self-test cases, both directions; `./tools/notice-check.ps1 -Fix` writes a
|
||||
14. `tools/changelog-check.ps1 -SelfTest` — nine cases, five expected RED. The live half needs a pull request's changed-file list and is supplied by `ci.yml`
|
||||
14b. `tools/release-notes.ps1 -SelfTest` — five cases over a fixture changelog (a dated and an undated section, a missing one, a prefix that must not match, an empty one), and since beta.24 three over a temporary tree: a version with its own `docs/changelog/<version>.md` is read from it, one without from `CHANGELOG.md`, a prefix of a file name is not that file. The live half needs a tag's version and runs in `release.yml`, where a missing or empty section is a red release (P4 PR-5)
|
||||
14e. **`tools/nvapi-readonly-check.ps1 -SelfTest`, then live** (owner decision D108, 2026-11-11) — every `NvAPI_*` call in `src/native/FrameLedger.NvapiBridge/src/fl_nvapi_bridge.cpp`, the one translation unit that links `nvapi64.lib` into a shipped binary, is on `tools/nvapi-allowed-calls.txt` and every name there is called; a name that sets, saves, restores, deletes, registers, resets, enables, disables or controls something is red **even when the list names it**, and so is one that returns an identifier (D104) — three reads the verb rule would refuse are exempt by name, each with its reason. Comments and string literals are taken out first, so a setter named in the comment that says it is never called is not a call. Seventeen self-test cases, both directions. Text only: it runs with or without the native build. `18_GPU_VENDOR_APIS` §Runtime policy's "never call a setter", which was a sentence until the bridge went from fourteen calls to forty-four
|
||||
14g. **`tools/input-readonly-check.ps1 -SelfTest`, then live** (owner decisions D155–D163, 2026-11-14) — what FrameLedger asks Windows about controllers, the keyboard and the mouse. Every Windows function the input reader calls is declared in ONE file, `src/FrameLedger.Infrastructure/Input/Win32Input.cs`, and is on `tools/input-allowed-calls.txt`; every name there is declared; a name that sends to a controller (`XInputSetState`, any `HidD_*`), injects input (`SendInput`), reads a key (`GetAsyncKeyState`, `GetKeyState`, `GetKeyboardState`, `XInputGetKeystroke`) or installs a hook is red **even when the list names it**; no managed source outside `src/FrameLedger.Infrastructure/Input/` names an input function at all, and `NativeMethods.txt` asks CsWin32 for none; raw input is registered for joysticks and gamepads only — `InputReader.RegisteredUsages` is exactly usage page 1, usages 4 and 5, and the backend builds its registration from it and writes no usage as a number; and **no native source names an input function** — nothing loaded into a game reads input. Comments and string literals are taken out first. Seventeen self-test cases, both directions. Text only; it does not look at the tests, which may drive a real keyboard for the App's own shortcuts. `21_INPUT_DEVICES` §What is never read, which the Privacy Policy repeats to the user
|
||||
14f. **`tools/overlay-fields-check.ps1 -SelfTest`, then live** (owner decision D116, 2026-11-12) — the same for the code loaded into a game: every member of a vendor's struct the Overlay reads for Advanced metrics is read in ONE header, `src/native/FrameLedger.Overlay/include/fl_adv_fields.h`, through parameters with fixed names, and is on `tools/overlay-allowed-fields.txt`; every name there is read; the parameters are not aliased and `->` reaches nothing but `desc` and the Overlay's own `region`; no other Overlay or Vulkan-layer source reads a listed member; **a camera's position, axes and matrices** (`cameraPos`, `cameraUp`, `cameraRight`, `cameraFwd`, the five matrices, `cameraPinholeOffset`, `cameraPosition`, `cameraForward`) **are named nowhere in those sources and not on the list, whatever the list says**; and neither `sl::Constants` nor `ffxDispatchDescFrameGenerationPrepareV2` is copied by value or measured with `sizeof`. Comments and string literals are taken out first. Nineteen self-test cases, both directions. Text only. It reads names, not types — which struct version carries a member is `17_HOOK_ENGINE` §Which struct version carries which field and ctest `fl_adv_fields`
|
||||
14d. **`tools/docs-split-check.ps1 -SelfTest`, then live** (beta.24, owner decision D66) — `CHANGELOG.md` holds no released section beside `[Unreleased]`; each `docs/changelog/<version>.md` holds one `## ` heading, its own `## [<version>] - date`, and no relative link (the App renders release notes as `CHANGELOG.md`); `CHANGELOG.md` and the files under `docs/changelog/`, and `docs/HANDOFF.md` and the files under `docs/handoff/` — and since PR-5 `docs/20_OPEN_QUESTIONS.md` and `docs/open-questions/`, `docs/spike-notes.md` and `docs/spike-notes/` — name each other in both directions. Eleven self-test cases, both directions
|
||||
14c. **`tools/buildid-check.ps1 -SelfTest`** (beta.18) — eight cases, both directions: a binary built from a dirty tree (`-dirty`, or the short form's `+`), one with no id, a missing one, and an expected id that is dirty or not an id are red. The live half needs the release's clean-checkout id and runs in `release.yml` over the published tree (§Release-time token substitution)
|
||||
|
||||
+4
-1
@@ -357,7 +357,10 @@ from CI.
|
||||
writes into the checkout, since the scanner walks all of it (`build/`, with the sources CMake fetches there, `out/`,
|
||||
every `bin/` and `obj/`, `TestResults/`) — SonarCloud also drops what `.gitignore` names (the first run: "63 files
|
||||
ignored because of scm ignore settings"), and the patterns say it in the file rather than rely on that; the same
|
||||
duplication exclusions; C++20; UTF-8; the OpenCover paths; the compilation database;
|
||||
duplication exclusions *(and, since 2026-11-12, `src/FrameLedger.Domain/Metrics/HookFamilies.cs`: the Domain's
|
||||
mirror of `FlHookFamily`, the same enum twice by design and held together by `MetricEnumMirrorTests`. The six
|
||||
members 0.1.0-beta.45 added to both were 3.7 % duplication on new code against the gate's 3 %, and failed the gate
|
||||
on the release's commit with no issue open)*; C++20; UTF-8; the OpenCover paths; the compilation database;
|
||||
**`sonar.cs.roslyn.ignoreIssues`** — Roslynator, Meziantou, the VS threading and the .NET
|
||||
analyzers already gate the build, warnings as errors, and what they report at a lower severity is this project's
|
||||
choice, so only SonarCloud's own rules are imported; and **two rules ignored where they apply by design** — `S8417`
|
||||
|
||||
@@ -31,6 +31,7 @@ The anti-cheat guard is the one component where a bug can cost someone an accoun
|
||||
- **Record and header layout:** `static_assert(sizeof(...) == 64)` and `offsetof` assertions for `FlFrameRecord` **and all ~~three~~ ~~four~~ five header structs** *(five since layout 5, 2026-11-11: `FlAdvancedState`, 1472 bytes; what reads and writes it is tested at four levels since 0.1.0-beta.40 — `fl_adv_fields` the Overlay's header alone, `fl_guard` `[advanced]` the injected Overlay with the word off and on, `InGameAdvancedSamplerTests` / `CaptureSessionTests` / `SessionRecorderTests` what the Agent makes of a publication, and `AgentEndToEndTests.WhatTheGameTellsFsrIsStoredOnlyByASessionThatRecordsAdvancedMetrics` the shipped Agent, the real Overlay and the harness: two sessions of one target, the first storing nothing of it)* (`FlShmHandshake`, `FlWriterState`, `FlControlBlock`, and `FlDisplayState` since layout 4, beta.10) — plus D33's `FlTolerance`, mirrored the same way *(corrected 2026-10-04)* — the Agent reads across the process boundary in every one of them. Both halves exist as of 2026-08-05: the native side is `layout_test.cpp` plus the `static_assert`s (ctest `fl_shm_layout`), and the runtime offset dump from `tools/fl-layout-dump` is consumed by `ShmLayoutMirrorTests`, which walks the field list in **both directions** and additionally asserts blittability — `Marshal.SizeOf` and every offset stay correct for a mirror that uses `[MarshalAs(ByValTStr)] string`, while `Unsafe.SizeOf` drops from 64 to 40 and the struct can no longer be read from a mapped view.
|
||||
- **Fault policy:** injected SEH faults in a fake hook body → counter increments, original still called, self-disable at 3.
|
||||
- **Hook index verification, by behaviour.** A vtable slot carries no identity, so "check that slot 8 *is* `Present`" is not a question the runtime can answer — the earlier wording here required something unimplementable. What is answerable: patch the slot, call the method, see whether the detour ran (`17_HOOK_ENGINE` §Getting vtable addresses; proved for slots 8, 13 and 22 in `spike-notes.md` §H4). Runs headless on CI via WARP and `CreateSwapChainForComposition`. A deliberate mismatch aborts installation instead of patching.
|
||||
- **A run that was cut short is not a pass** (2026-11-13). ctest calls a test passed when its process exits with 0, and on that day the development PC's security software removed a freshly linked `fl_guard_test.exe` while the gate ran: ctest printed `fl_guard ... Passed 0.66 sec` for a suite that takes three minutes, and the gate went red only because the next test runs the same executable and could not find it. So **every native test now names the line it ends on** — `fl_test_completes(<test> <regex>…)`, or `fl_catch2_test_completes(<test>…)` for a Catch2 executable (its `All tests passed (` line, or its summary row when a case was skipped, and never a row that names a failure) — and ctest requires that line (`PASS_REGULAR_EXPRESSION`; the helpers and the reasons are in `src/native/CMakeLists.txt`, above `enable_testing()`). Three things hold it: **the configure fails** when a test in `tests/` or `tools/` was registered without one (tried: a test added bare stops CMake with its name); **four canary tests** print what a Catch2 run would — nothing, its last line, a row with a skipped case, a row with a failure beside "passed" — through the same helper, and the two that must be red are `WILL_FAIL`; and the tests that were passing on a line printed in the *middle* of their run (`fl_nvapi_bridge`, `fl_process_stats`, `fl_nvapi_probe`, `fl_signer_probe`) now need that line and, after it, their last one. For `fl_nvapi_probe` this also closes what `fl_nvapi_bridge` was fixed for on 2026-09-25: a pass expression makes ctest ignore the exit code, so a run that printed its branch and then `FAILED` passed. `fl_signer_probe` accepts either ending — its criterion was always that the answers are printed. A `SKIP_RETURN_CODE` still wins over a missing line. **Not covered**: the managed tests (`dotnet test` reports a host that died) and a process that is stopped *after* printing its last line.
|
||||
- **Every probe must be shown to fail.** A probe that ends in an unconditional assertion is green by construction and its ctest is decorative — `fl_proxy_swapchain` shipped in exactly that state. Before a probe counts as a regression net, break the thing it watches and watch it go red.
|
||||
|
||||
## Managed unit tests
|
||||
@@ -158,6 +159,43 @@ own work item on the STA thread and puts back — and with the keys a parameter,
|
||||
> Until the run happens, the honest state of this line is *unmeasured*, not *passing*.
|
||||
3. Results recorded in the release notes ("measured overhead this release: …").
|
||||
|
||||
**What a patch costs when it goes in and comes out (since 0.1.0-beta.46) is not the per-present number above**, and
|
||||
is measured where it happens: `fl_guard`'s Streamline `[advanced]` case prints the microseconds of each install
|
||||
batch and of the stop's one restore (the Overlay's `PATCH_BATCH` lines), and the time from the unhook request to
|
||||
`UNHOOKED`; it asserts that every lazily installed patch is under a batch line, that the stop is one, and that the
|
||||
restore stays under a second — the bound the one-patch-at-a-time stop did not meet on the development PC. In a real
|
||||
game the same lines are in `logs\overlay-<pid>-….log` — read there on 2026-11-13 for five games: eighteen install
|
||||
batches, 81–262 ms for sixteen of them and 0.61 s and 1.26 s for two (`17_HOOK_ENGINE` §Unhooking, *Batches*); and
|
||||
on 2026-11-14 two restores of twenty-nine patches each, 83 ms and 86 ms, when the owner stopped the part inside a
|
||||
running game.
|
||||
|
||||
**The call into the driver (train C, 0.1.0-beta.47) is tested in three places, each for what the
|
||||
others cannot say.** `fl_reflex_summary` (Catch2) drives `fl_adv_fields.h`'s reader on reports written by hand: the
|
||||
two newest frames held back, a frame summed once, a span the driver did not report, a span no frame can have, frame
|
||||
ids that start again, and the ten words of a publication — and since 0.1.0-beta.48 the driver's two own times
|
||||
(summed over the frames that gave one, each with its own count; zero and more than a second are not counted and
|
||||
refuse nothing) and the bit a multiplier has — and since 0.1.0-beta.49 the counts for the native log: every place
|
||||
a summed frame can be in, a span of a microsecond, an active time as long as the span, a refused frame, when a
|
||||
batch is due, a batch closed by a change of state and the thirty-two such closings a request has, the six lines
|
||||
and what each carries; a hidden `[.bench]` case is the measurement of one report's cost. `fl_watchdog_tick`
|
||||
(Catch2, no thread and no clock) drives the grid the watchdog's periodic tick is on: sixty ticks each late and
|
||||
each followed by work keep whole seconds, a wait is never rounded down, a tick woken early is not periodic and
|
||||
moves nothing, a late tick is not followed by another within half a period. `fl_guard`'s nine `[latency]` cases
|
||||
(the eighth reads the log: the first batch after ten reads, by number, and what is left when a flush is asked for
|
||||
— against the stand-in's `kModeGpuShapes`; the ninth keeps the loader waking the watchdog without pause — a
|
||||
thread that asks for `opengl32.dll` for as long as the target lives — and holds one publication a second, each
|
||||
with a read, none within half a second of another: 35 720 publications in eight seconds on the code before it; a
|
||||
hidden `[.measure]` case prints ninety reads' own lines) inject the Overlay
|
||||
into a Direct3D 12 target that has loaded a stand-in `nvapi64.dll`, and read that module's call counts from outside
|
||||
through its named section (`fl_stub_nvapi_shared.h`) — so "the driver was not called" is a count: not asked → not
|
||||
even asked for the addresses; asked → about one read a second, sums equal to the stand-in's, every counted read a
|
||||
received call; an error; a span not reported; the request off; a second session; the stop; a call of 50 ms (the
|
||||
last one); a fault (counted once, the hooks stay); a module without the getters; no module (none is loaded); a
|
||||
module beside the executable (refused, never asked); Direct3D 11 (not read). `fl_reflex_probe_stub` runs the same
|
||||
header, `fl_reflex.h`, in a process that **enforces Control Flow Guard** — the injected cases do not: `hook-harness`
|
||||
is not a CFG image. **None of them is a driver.** `fl-probe-reflex --real` is the measurement against the installed
|
||||
one, run by hand (`spike-notes` §31), and a real game is owner-only item 45.
|
||||
|
||||
## Tier cross-validation (accuracy regression net) — **GONE, 2026-08-28, and this is the entry to read before planning P5**
|
||||
|
||||
~~Run the same game session with Tier 1 and Tier 2 simultaneously where possible (ETW does not conflict with hooking) and compare frametime distributions: Avg/1% Low must agree within **1%**. Divergence beyond that means one of the two paths is wrong and blocks the release. This is also the check that would have caught the original detection-accuracy problem.~~
|
||||
|
||||
@@ -332,6 +332,50 @@ CI/CD with the native build (`release.yml` exists since P4 PR-5, 2026-09-14 —
|
||||
|
||||
**Total ≈ 5.5–6.5 weeks full-time** — roughly 1.5–2 weeks more than the ETW design, which is the honest price of the accuracy.
|
||||
|
||||
## After the controller train — the owner's order (2026-11-14)
|
||||
|
||||
Advanced metrics is closed (D154) and the controller feature is being built as 0.1.0-beta.50's train. Asked what
|
||||
comes after, the owner was shown six directions and chose four of them, and added distribution. **This is the
|
||||
order of work after the controller train; each begins with a plan of its own and the owner's approval.** Nothing
|
||||
here is designed yet, and what is marked *to verify* is a lead, not a finding.
|
||||
|
||||
1. **Time actually played (AFK segmentation).** The v2 backlog's "AFK segmentation via `GetLastInputInfo`", moved
|
||||
up: the controller train already stores when the keyboard, the mouse or a controller was in use, so the time
|
||||
nobody was at the game can be told apart and left out of a session's averages. Timestamps of activity only —
|
||||
never a key, as that train's Privacy text says.
|
||||
2. **More from what is already stored — interface only, no hook.** The comparison of two stretches of one
|
||||
session ("before and after I changed DLSS Quality to Balanced", v1.1 below), and a timeline for a game that
|
||||
marks where the driver, the game's build or the settings changed, so a drop in frame rate has a date. *To
|
||||
verify*: which of those changes the ledger already records for every session.
|
||||
3. **Stutter from shader compilation (PSO).** `03_METRICS` defines *PSO stutter %* and `05_DETECTION` says no
|
||||
writer exists. New hooks at pipeline creation: staged like Advanced metrics' train B — small releases, the
|
||||
overhead measured, the owner's real games between them, never first on a game inside the user-mode
|
||||
exception's trial (D38).
|
||||
4. **The in-game overlay (FR-15).** v1.1's first line below: live frame rate, frame time, upscaler and
|
||||
ray-tracing state drawn in the game, per game, off by default. The largest and the riskiest of the four — it
|
||||
draws in the game's process — so it comes last, with a risk review of its own (rule 5, and what an
|
||||
anti-cheat makes of a drawing module).
|
||||
5. **Distribution: winget and the Microsoft Store.** The owner uploads to the Store and fills in its listing by
|
||||
hand. FrameLedger has no product in Partner Center yet — the one there today is another program of the
|
||||
owner's — so which type it is submitted as (*EXE or MSI app*, or *MSIX or PWA app*) is part of what the plan
|
||||
settles. The repository's part is what the two channels need from a release. *To verify, before anything is promised*:
|
||||
- whether the Store accepts an **unsigned** installer for an *EXE or MSI app* — the installer is unsigned
|
||||
today (`CLAUDE.md`, Packaging), and if the Store wants a certificate that is a cost and a decision of the
|
||||
owner's; whether an MSIX package is a real alternative for a program that loads a library into games and
|
||||
registers a Vulkan layer;
|
||||
- the installer's silent switch and a versioned, permanent download address for each release, which both
|
||||
channels ask for; whether either takes a pre-release version;
|
||||
- who updates an installation that came from winget or the Store — the App's own updater (Velopack) or the
|
||||
channel — and that the two cannot fight;
|
||||
- a winget manifest per release (address, SHA-256, switches) and whether `release.yml` writes it or the owner
|
||||
submits it;
|
||||
- rule 8 is untouched: a channel that delivers the installer is not a network call of the App's.
|
||||
|
||||
**Not chosen, and not refused**: a stabilising pass with a cross-check against another tool (the limits page
|
||||
still says no reading has been checked against one), and export for CapFrameX and for video overlays. Two things
|
||||
only the owner can settle stay open beside them: what leaving beta takes, and code signing — which direction 5
|
||||
may force.
|
||||
|
||||
## v1.1 — earned features (only after the data path is stable)
|
||||
|
||||
- **In-game overlay** (FR-15): we are already in the process; draw live FPS/frametime/upscaler/RT state. Opt-in per game, off by default. Borderless and fullscreen-flip both handled since we own the swapchain.
|
||||
|
||||
+179
-11
@@ -172,6 +172,81 @@ Every hook must be listed here with a purpose. Anything not on this list is not
|
||||
| ✅ `opengl32.dll!wglSwapBuffers` (2026-09-06, P1 item 4) | The OpenGL present hook (§Presentation). A system module, not a vendor one, so — like the row below — it is deliberately **not** in `FL_HOOK_INVENTORY` and `hookinventory-check` does not cover it; listed here so the table above and these two rows together are the whole inventory |
|
||||
| ✅ `kernelbase.dll!LoadLibraryExW` (2026-09-06, P1 item 1) | The wake for lazily loaded runtimes and the in-process anti-cheat stop — §DLL entry step 3 above carries the mechanism. **Rule 4:** it reads one argument the API was given (`flags`) and one property of a handle the loader just returned to *its own caller* (the module file name); nothing of the game's. **~~It is the only hook on a system module, and~~ Like `wglSwapBuffers` above it, it is deliberately not in `FL_HOOK_INVENTORY` (corrected 2026-10-04):** that table is *vendor* symbols resolved by name and gated by `hookinventory-check` against `vendor-exports.json`, and `LoadLibraryExW` is neither vendor nor uncertain. It is listed here instead so the table above and this row together are the whole inventory. It **never** installs, uninstalls or patches anything itself (§H2) |
|
||||
|
||||
### Calls the Overlay makes into a driver — not hooks, and the only ones
|
||||
|
||||
Everything else on this page learns what it learns from the arguments of a call the game made. This is the one
|
||||
place the Overlay **makes a call of its own** into code that is neither the game's nor FrameLedger's, and it is
|
||||
listed here so that nobody takes it for a hook or adds a second one without the same ruling
|
||||
(`CLAUDE.md` rule 4's note of 2026-11-13, owner decisions D132, D136, D138–D141).
|
||||
|
||||
| Call | When, where | Rule 4 | What bounds it |
|
||||
|---|---|---|---|
|
||||
| **NVIDIA's `NvAPI_D3D_GetLatency` and `NvAPI_D3D_GetSleepStatus`** — the driver's two read-only latency getters (Advanced metrics train C; `fl_reflex.h`; **since 0.1.0-beta.47**) | **Only while a session asks for Advanced metrics** (D138: no switch of its own), only for a Direct3D 12 swap chain whose device is the one the Overlay holds, **about once a second, on the presenting thread, after that present's record is published**. The watchdog finds the addresses once for the process and arms one read at a time; a present pays one relaxed load. The addresses come from an `nvapi64.dll` **the game had already loaded** — asked for by name, never loaded — through its `nvapi_QueryInterface` and the two interface ids of the vendored `nvapi_interface.h`. The Overlay links no NVAPI | The owner's ruling (D132): a driver's read-only getter called with the device behind the swap chain the Overlay hooks reads the driver's report, not game memory, and writes nothing. Getters only — never a setter, a marker or a sleep (`tools/nvapi-readonly-check.ps1` holds which ids code loaded into a game may name: these two). What is read of the two structs is on `tools/overlay-allowed-fields.txt` like every other vendor member | **An `nvapi64.dll` in the executable's own folder is refused** (D140): the driver's is in Windows' directories. **A fault** in a getter is caught by a guard of its own, counted once in `faultCount`, and ends the reads for the process. **One call of 2 ms or more** ends them too (D141). **A call that has not returned after two seconds** is logged, flushed and published as stalled — nothing can stop it, and the presenting thread it holds is the game's. Each is until the game exits |
|
||||
|
||||
**Where the addresses are, measured** (`fl-probe-reflex --real`, driver 32.0.16.2114): System32's `nvapi64.dll` is a
|
||||
shim and answers the two ids with addresses inside **`nvapi64_impl.dll`**, in the driver's own store. So an address
|
||||
is accepted when it is executable code of an image the process has loaded, and **the Overlay keeps a reference on
|
||||
that image as well as on `nvapi64.dll`** — two modules the game loaded, never released, for the reason
|
||||
`ResolveScoped` gives: a presenting thread may be about to call. `nvapi64_impl.dll` is a Control Flow Guard image;
|
||||
the probe, which enforces CFG, has made the calls from the header that ships, so on this driver the getters are
|
||||
valid targets. **Not excluded**: a game that enforces CFG on a driver the probe has not been run against — a target
|
||||
that were not valid is a fast-fail no guard catches.
|
||||
|
||||
**In a real game** (the owner, 2026-11-14, Phantom Blade Zero on 0.1.0-beta.47, three sessions, frame generation
|
||||
×3 and off): the module was found four to five seconds after the attach — `nvapi64.dll` in System32, the getters in
|
||||
`nvapi64_impl.dll`, as on the probe — a read was made about every second for 344 s, 52 s and 1 119 s, **the slowest
|
||||
call took 24, 20 and 45 µs**, and no latch fired: no error, no slow call, no fault, no stall. **Cyberpunk 2077 the
|
||||
same morning**, two sessions (frame generation ×2 and off, 260 s and 581 s): found 4.8 s and 2.6 s after the attach,
|
||||
the slowest call 34 and 65 µs, no latch. Two Direct3D 11 games and one Direct3D 12 game with no `nvapi64.dll` were
|
||||
left alone, each with its one line. Two games read, one driver.
|
||||
|
||||
**Two more members of the same report, and the multipliers seen (0.1.0-beta.48; owner decisions D142, D144).** In
|
||||
Phantom Blade Zero the span between the driver's two GPU marks was longer than the frame's whole: it includes the
|
||||
card's waiting. NVIDIA's header has the figure that does not — `gpuActiveRenderTimeUs`, "excluding the idles in
|
||||
between" — and beside it `gpuFrameTimeUs`, one frame's GPU end to the next's. Both are read from the report the
|
||||
getter already filled: **no call is added, and no interface id** (`tools/nvapi-readonly-check.ps1` is unchanged;
|
||||
the two names are on `tools/overlay-allowed-fields.txt`). The buffer is the Overlay's own, so there is no question
|
||||
of a member lying past what a game allocated; an older driver leaves both zero, and zero is read as *not given* —
|
||||
each time has its own count, and neither decides which frames the seven spans are made of. The sleep status'
|
||||
frame-generation multiplier is now also kept as the set of values a session saw (a session that generated ×2 and
|
||||
ended in a menu read 1). **One defect fixed with it**: a read that ended after a session's last tick was taken by
|
||||
the next session as its first point; a new request now drops it. **Measured** (the header's own function, the
|
||||
Overlay's flags, a report of 62 summed frames, 2 million reports × 3, twice): 393–396 ns before, 429–434 ns after
|
||||
— **+36 ns a read**, once a second, and after the call's time has been taken, so it cannot reach the 2 ms latch.
|
||||
The present path is unchanged: one relaxed load.
|
||||
|
||||
**Since 0.1.0-beta.49 each summed frame is also counted for the native log** (owner decisions D148, D151;
|
||||
§Native logging, `LATENCY_FRAMES`). The owner's ten sessions on beta.48 (HANDOFF, item 46) gave both of the
|
||||
driver's own times in every frame report of both games — and in Cyberpunk 2077 without frame generation the mean
|
||||
active time was **longer** than the mean span between the two GPU marks (3.17 against 2.79 ms), which the two
|
||||
means cannot explain: the span's is over every summed frame, one of no length included, the active time's over
|
||||
the frames that gave one. So the reader places each summed frame by its own two numbers (`CountGpuTimes`), after
|
||||
the frame is accepted: which frames are summed does not change, and the seven spans, the two times and their
|
||||
counts are what they were. **No new call, no further member of the report** — the two GPU marks and
|
||||
`gpuActiveRenderTimeUs` were read already — and nothing of it leaves the process: the watchdog adds each read's
|
||||
counts to a batch and writes the batch to the log. **Measured** (the same instrument: 2 million reports × 3,
|
||||
twice): 424–435 ns before, 490–499 ns after — **+65 ns a read**, once a second, after the call's time has been
|
||||
taken. `fl_reflex_summary_test "[.bench]"` is that measurement in the tree. The present path is unchanged.
|
||||
|
||||
**Since 0.1.0-beta.49 the read is on a grid of one second** (owner decision D150; `fl_watchdog_tick.h`). The
|
||||
watchdog used to wait a second *after* each tick's work, and a tick the LoadLibrary detour woke was a tick like
|
||||
any other: it took what the last read left, published it and — less than a second having passed since the last
|
||||
arm — armed nothing, so the next publication carried no read. The Agent samples on a period of exactly one second
|
||||
since 0.1.0-beta.48, and its sessions showed the holes: 0.4 to 16 % of a session's samples without a report
|
||||
(HANDOFF, item 46). Now the watchdog's **periodic** tick is due at a deadline by the performance counter, and the
|
||||
next deadline is one period after the one that was due, not after the moment the tick ran; a tick woken early
|
||||
does everything it did — the request is followed and the hooks a session asks for go in at once — **except take
|
||||
the driver read and publish region 5**, which are the periodic tick's. One read is armed at every periodic tick
|
||||
(`g_latArmedQpc` and its "a second since the last arm" are gone). A periodic tick that ran more than half a
|
||||
second late is not followed by another on the grid's next mark: the grid starts again from it, so **two reads are
|
||||
never less than half a second apart** — "about once a second" still, and no longer "at most". Nothing on a game
|
||||
thread changed: the presenting thread makes the read when it finds the gate armed, as before. **Measured** on `hook-harness` with the stand-in module, by the batches' own lines (`fl_guard_test "[.measure]"`): ten reads in 9 996 ms, the next twenty in 20 002, the next sixty in 59 997, each batch with as many periodic ticks as reads; and with a thread asking the loader for a module without pause — 18 240, 36 427 and 143 424 early wakes in the three batches — 9 997, 20 000 and 59 999 ms for the same reads. On the code before it the second case published 35 720 times in eight seconds, with nine reads. **Not measured in a game**, and not the whole of the holes: the Agent overwrote a reading that waited for a sample, which is its own change (`07_IPC` §Region 5).
|
||||
|
||||
**The gate.** One word, four states — idle, armed, reading, off (`dllmain.cpp`, above `ReadLatencyOnce`). Only the
|
||||
watchdog arms; a presenting thread takes *armed* to *reading* by compare-exchange and owns the 15.4 KB report
|
||||
buffer (static storage, never a game thread's stack) and the read's result until it stores *idle* or *off*; the
|
||||
watchdog takes the result only when nobody is reading. No lock, and no second read while one is under way.
|
||||
|
||||
### Watchdog observations — not hooks, and listed here so nobody mistakes them for one
|
||||
|
||||
| Observation | Mechanism | Rule 4 | Why |
|
||||
@@ -196,9 +271,9 @@ Every hook must be listed here with a purpose. Anything not on this list is not
|
||||
| NGX parameter accessors (`NVSDK_NGX_Parameter_SetI/GetI/SetUI`) — **exported by `sl.common.dll` only; see below** | `Width`/`Height` (render) vs `OutWidth`/`OutHeight` (output), `PerfQualityValue` (quality preset), sharpness |
|
||||
| ✅ Streamline: `slEvaluateFeature` · ~~⏳ `slInit`~~ *(not hooked, and not to be: owner decision D129, 2026-11-12 — its row below says why)*, ~~`slSetFeatureLoaded`~~ *(its own row below since beta.45)*, ~~`slSetConstants`~~ *(its own row below since beta.43)*, ~~`slGetFeatureRequirements`~~ *(its own row below since beta.44, with `slGetFeatureVersion`)* | Feature set actually active when the game goes through SL rather than NGX directly (`kFeatureDLSS`, `DLSS_G`, `DLSS_RR`, `Reflex`, `NIS`; since beta.34 `kFeatureDLSS_NR` — DLSS 5's neural rendering, its own fact bit and family `FL_HOOK_SL_NEURAL_RENDERING`, D84; rule 4: the `feature` argument of the API hooked, nothing else). **Built 2026-08-09**, identity only: one MinHook detour on `sl.interposer.dll!slEvaluateFeature`, resolved **module-scoped** and installed lazily by the watchdog. Sets `FL_MEASURED_UPSCALER` + `FL_HOOK_UPSCALER_IDENTITY`; decodes `kFeatureDLSS`/`kFeatureNIS` and reports `FL_UPSCALER_UNKNOWN` for anything else. **Never `FL_UPSCALER_NONE`** — a Streamline-only writer cannot see FFX, XeSS or NGX-direct, and `NONE` is the only one of the three states that may be aggregated as a negative. **Since 0.1.0-beta.40 (Advanced metrics train B, D111), and only while the Agent asks** (`FlControlBlock.advancedRequested`): the `sl::DLSSOptions` a title chains into `inputs` — the struct the quality mode is read from — is read further: `outputWidth`/`outputHeight`, `preExposure`, `exposureScale`, `colorBuffersHDR`, the five presets of version 1, and where the struct's own `structVersion` proves them present `ultraQualityPreset` and `useAutoExposure` (≥ 2) and `alphaUpscalingEnabled` (≥ 3) — §Which struct version carries which field. Rule 4: more members of the same argument of the same call; `fl_adv_fields.h` is the one place, `tools/overlay-fields-check.ps1` holds it. No new patch site. **Measured** (the header's own functions, `/O2 /guard:cf /Qspectre /MT`, 20 M calls × 3): +9.5–11.7 ns per evaluation that chains the options while asked; with the word at 0, one relaxed load and a branch not taken — below what the bench resolves. Most titles set these through `slDLSSSetOptions`, which is not an export, and read N/A (train D) |
|
||||
| ✅ Streamline: `slSetConstants` (0.1.0-beta.43, Advanced metrics train B; owner decisions D111–D116, D122) | **What the game tells Streamline about a frame**, once per frame and viewport, read from the `sl::Constants` it passes — rule 4: an argument of the call hooked, and of it only the members named here. **Read:** `jitterOffset`, `mvecScale`, `cameraNear`, `cameraFar`, `cameraFOV`, `cameraAspectRatio` and the seven `Boolean`s (`depthInverted`, `cameraMotionIncluded`, `motionVectors3D`, `reset`, `orthographicProjection`, `motionVectorsDilated`, `motionVectorsJittered`). **Never read:** the five matrices (bytes 32..351 of the struct), `cameraPinholeOffset`, and the camera's position and three axes (bytes 368..423) — `tools/overlay-fields-check.ps1` refuses their names anywhere in code loaded into a game, and ctest `fl_adv_fields` publishes two structs that differ in every one of those bytes and gets the same bytes out. **The one row that is not installed unless asked for** (D111): `InstallByFamily` returns before it resolves the symbol in a process the Agent has never asked for Advanced metrics — resolving takes a reference on the module — so with the option off the export's first bytes are the file's (`fl_guard` `[advanced]` reads them from the target). Once asked, the patch goes in on that watchdog tick and stays for the life of the process; the detour forwards without looking while the request is off, and after a stop (`MayObserve`). **Every call** checks the struct's GUID and a `structVersion` of at least 1 before any member is read, and the viewport handle's the same way; every member read is one version 1 carries, so a version-1 struct laid against unreadable memory is read whole without a fault (the same ctest). **Summaries are the first viewport's**: a title with two viewports sets constants for each every frame, and "the last value" across them would flip twice a frame; the call count is of every viewport. `FLT_MAX` is Streamline's "not set" here and is kept nowhere (D119's plane at infinity is FidelityFX's). Family `FL_HOOK_SL_CONSTANTS` (bit 13), published with the patch: it entitles no field of a frame record, and tells "hooked, never called" from "not hooked". **Measured overhead** (the detour's body on the headers, the Overlay's flags, 20 million calls a run, three runs): not asked **+0.57 / +0.60 / +0.58 ns**; asked, the summarised viewport **+19.61 / +19.54 / +19.79 ns**; asked, another viewport +5.83 / +6.01 / +5.62 ns. |
|
||||
| ✅ Streamline: `slGetFeatureVersion` and `slGetFeatureRequirements` (0.1.0-beta.44, Advanced metrics train B's third step; owner decisions D111–D116, D122) | **What Streamline answers when the game asks about a feature** — which version it is, and what it requires. Two rows, two patches, two detours of one shape: **the original runs first, exactly once, on every path, with both arguments forwarded untouched**, and the struct the game passed is read only when the original said `eOk` — a refusal leaves the struct as the game made it, which is not an answer. Rule 4: an argument of the call hooked, read after the call, and of it only the members named here. **Read from `sl::FeatureVersion`:** `versionSL`, `versionNGX`. **Read from `sl::FeatureRequirements`:** `flags`, `maxNumCPUThreads`, `maxNumViewports`, `numRequiredTags`, `osVersionDetected`, `osVersionRequired`, `driverVersionDetected`, `driverVersionRequired`. **Never read:** `requiredTags` — the pointer the count belongs to — and everything after `driverVersionRequired`: the Vulkan queue counts and the pointers to the names of extensions and features. **No pointer of the game's is followed** (`tools/overlay-fields-check.ps1`, parameters `fv` and `fr`; ctest `fl_adv_fields`: two answers that differ only in those bytes publish the same region, and an answer cut off where the Vulkan members begin, laid against unreadable memory, is read without a fault; the injected `fl_guard` case's stub hands back wild pointers and no fault is counted). **Installed only where asked for** (D111), as `slSetConstants` is: `InstallByFamily` returns before it resolves either symbol in a process the Agent has never asked for Advanced metrics; once in, a patch stays for the life of the process and its detour forwards without looking while the request is off. **They are the first two rows of the table**: a game asks these while it starts, the watchdog patches rows in the table's order, and each patch stops the game's threads for a moment (0.1–0.25 s apart in the owner's logs of 2026-11-12, where `slSetConstants` was the fifth Streamline patch in, 1.9–7.8 s after the attach). In a process never asked they are passed over and the order changes nothing. ~~**Most sessions will still have missed the calls** — an attach after the game's start-up is the usual case — and the session then says the call was hooked and the game did not ask again.~~ *(Measured 2026-11-12, the owner's eight sessions on beta.44: both calls were read in six of six Streamline sessions on five games — Unreal's Streamline plugin asks again after the attach, Cyberpunk 2077 asks again for requirements and not for versions. A game that asks only while starting still reads "hooked, not asked again".)* Three conditions before a read, as for `slSetConstants`: the Agent is asking, observing has not stopped, and the struct carries its own GUID and a version of at least 1 on this call (a struct with another GUID is not kept: the injected case sends one). Every member read is version 1's (§Which struct version carries which field). **Twelve slots** in region 5 (`FlAdvancedState.features`, layout 5 as it was), one per feature in the order first asked about; the last answer about a feature is the one kept; a thirteenth feature is not kept. **A new request does not empty them**: what version a feature is and what it requires are facts about the process, and a second session of a game that kept running would otherwise have nothing where the first had the answer — the one group `Reset` leaves, with its bit of the mask. Streamline 1.x is refused before anything is resolved (`SpeaksStreamline2`). Families `FL_HOOK_SL_FEATURE_VERSION` (bit 15) and `FL_HOOK_SL_FEATURE_REQUIREMENTS` (bit 16), each published with its patch; neither entitles a field of a frame record. **Measured overhead** (the detours' bodies on the headers, the Overlay's flags, 20 million calls a run, three runs, eight features asked about in turn): the version — not asked **+0.58 / +0.61 / +0.58 ns**, asked **+14.82 / +14.54 / +14.47 ns**; the requirements — not asked **+0.58 / +0.63 / +0.61 ns**, asked **+20.88 / +21.01 / +20.96 ns**. A game makes these calls a handful of times. |
|
||||
| ✅ Streamline: `slIsFeatureSupported`, `slIsFeatureLoaded`, `slSetFeatureLoaded` (0.1.0-beta.45; owner decisions D129–D131) | **Whether a feature is supported, whether it is loaded, and the game switching it on and off.** Three rows, three patches. Rule 4: bare arguments and results of the calls hooked, and no vendor struct at all — the feature's id; the `sl::Result` `slIsFeatureSupported` returned, **every result**, since a refusal is the answer to that question (the original runs first, both arguments forwarded untouched); the `bool` `slIsFeatureLoaded` wrote, read only when it returned `eOk`; the `bool` the game passed to `slSetFeatureLoaded`, noted before the call. **The adapter `slIsFeatureSupported` is asked about is never read** (D131): `sl::AdapterInfo` holds the adapter's LUID or a Vulkan physical device; the detour forwards the reference and `tools/overlay-fields-check.ps1` refuses the names of its members (`deviceLUID`, `deviceLUIDSizeInBytes`, `vkPhysicalDevice`) anywhere in the Overlay and the Vulkan layer — the fixture's adapter carries a wild pointer. **Installed only where asked for** (D111), as the four rows before them. `slIsFeatureSupported` and `slIsFeatureLoaded` follow the two rows of beta.44 at the head of the table; `slSetFeatureLoaded` follows `slSetConstants`. **Kept in word 1 of the feature's slot** (region 5, layout 5 as it was): bit 2 and the result in bits 8..15, bits 3 and 4, bits 5 and 6 — the last two a session's, cleared by a new request; the rest the process's, kept (`fl_adv_fields.h` `kFeatureSessionBits`). A refused feature therefore has a slot now, with nothing in it but that word. The declarations of the three functions are the same from Streamline v2.0.0 to v2.14.16, and `sl::Result` is the same forty codes in the same order at all sixteen tags (`include/sl_result.h`, `05a3c7e3889c` … `8a844b68ff55`), so a code means the same whatever interposer answered. Families `FL_HOOK_SL_FEATURE_SUPPORTED` (bit 17), `FL_HOOK_SL_FEATURE_LOADED` (18), `FL_HOOK_SL_SET_FEATURE_LOADED` (19), each published with its patch. **Measured overhead** (the detours' bodies on the headers, the Overlay's flags, 20 million calls a run, three runs, eight features in turn): `slIsFeatureSupported` — not asked **+1.50 / +1.48 / +1.50 ns**, asked **+11.97 / +11.98 / +12.08 ns**; `slIsFeatureLoaded` — **+1.79 / +1.77 / +1.89 ns**, **+12.35 / +12.31 / +12.33 ns**; `slSetFeatureLoaded` — **+1.44 / +1.47 / +1.80 ns**, **+11.28 / +11.54 / +11.45 ns**. **`slInit` is not a row and will not be** (D129): a game calls it once, before the Overlay is in the process or before a patch can land — launch mode waits for the presentation runtime before it injects, nothing is ever patched on a game's thread (§H2), and a row that exists only for Advanced metrics waits for the Agent's request. **A stop takes about 160 ms for every patch it restores** (measured on the fixture, 0.1.0-beta.45: each `MH_DisableHook` snapshots the system's threads): twelve patches took 1.9 s, fifteen 2.4 s, and the watchdog's wait for the stop's log lines, 2 s until then, is now a quarter of a second for every patch the registry can hold. |
|
||||
| ✅ Streamline: `slAllocateResources`, `slFreeResources`, `slShutdown` (0.1.0-beta.45; owner decision D130) | **The game allocating and freeing a feature's resources, and shutting Streamline down — counted, and nothing else.** Three rows, three patches. Rule 4: the feature's id is the only argument looked at; the command buffer and the viewport of the two resource calls are forwarded and never read (the fixture's command buffer is a wild pointer), and `slShutdown` has no argument. **`slFreeResources` and `slShutdown` are on a game's way out**: each detour notes the call first and then calls the original, exactly once, and runs nothing of ours after it returns; the fixture goes on calling the stub after `slShutdown`, through every detour. **Installed only where asked for** (D111); the last three Streamline rows of the table. **Kept** in word 1 of the feature's slot as two four-bit counts — allocations in bits 16..19, frees in 20..23, each stopping at 15 and never carrying into its neighbour — and, for `slShutdown`, in `FlAdvancedState.slShutdowns` (@308, the first of three reserved words; layout 5 as it was) with `FL_ADV_VALID_SL_SHUTDOWN` (bit 6 of the mask). All three are a session's: a new request clears them. Families `FL_HOOK_SL_ALLOCATE_RESOURCES` (bit 20), `FL_HOOK_SL_FREE_RESOURCES` (21), `FL_HOOK_SL_SHUTDOWN` (22). The three declarations are the same from Streamline v2.0.0 to v2.14.16. **Measured overhead** (the detours' bodies on the headers, the Overlay's flags, 20 million calls a run, three runs): `slAllocateResources` — not asked **+0.70 / +0.72 / +0.80 ns**, asked **+10.43 / +10.53 / +10.74 ns**; `slFreeResources` — **+0.61 / +0.84 / +0.58 ns**, **+10.33 / +10.57 / +10.44 ns**; `slShutdown` — not asked within the bench's noise (+0.06 / −0.12 / +0.04 ns), asked **+3.39 / +3.37 / +3.52 ns**. Inventory 23 → 26 rows; a Streamline title with Advanced metrics asked for now carries thirteen patches on the interposer, and a stop restores each in about 160 ms (the row above). |
|
||||
| ✅ Streamline: `slGetFeatureVersion` and `slGetFeatureRequirements` (0.1.0-beta.44, Advanced metrics train B's third step; owner decisions D111–D116, D122) | **What Streamline answers when the game asks about a feature** — which version it is, and what it requires. Two rows, two patches, two detours of one shape: **the original runs first, exactly once, on every path, with both arguments forwarded untouched**, and the struct the game passed is read only when the original said `eOk` — a refusal leaves the struct as the game made it, which is not an answer. Rule 4: an argument of the call hooked, read after the call, and of it only the members named here. **Read from `sl::FeatureVersion`:** `versionSL`, `versionNGX`. **Read from `sl::FeatureRequirements`:** `flags`, `maxNumCPUThreads`, `maxNumViewports`, `numRequiredTags`, `osVersionDetected`, `osVersionRequired`, `driverVersionDetected`, `driverVersionRequired`. **Never read:** `requiredTags` — the pointer the count belongs to — and everything after `driverVersionRequired`: the Vulkan queue counts and the pointers to the names of extensions and features. **No pointer of the game's is followed** (`tools/overlay-fields-check.ps1`, parameters `fv` and `fr`; ctest `fl_adv_fields`: two answers that differ only in those bytes publish the same region, and an answer cut off where the Vulkan members begin, laid against unreadable memory, is read without a fault; the injected `fl_guard` case's stub hands back wild pointers and no fault is counted). **Installed only where asked for** (D111), as `slSetConstants` is: `InstallByFamily` returns before it resolves either symbol in a process the Agent has never asked for Advanced metrics; once in, a patch stays for the life of the process and its detour forwards without looking while the request is off. **They are the first two rows of the table**: a game asks these while it starts, the watchdog patches rows in the table's order, and each patch stops the game's threads for a moment (0.1–0.25 s apart in the owner's logs of 2026-11-12, where `slSetConstants` was the fifth Streamline patch in, 1.9–7.8 s after the attach). *(Since 0.1.0-beta.46 the rows a tick finds go in together, under one stop of the threads — §Unhooking, Batches — so the order no longer decides which row waits behind which; it is still the order of their log lines.)* In a process never asked they are passed over and the order changes nothing. ~~**Most sessions will still have missed the calls** — an attach after the game's start-up is the usual case — and the session then says the call was hooked and the game did not ask again.~~ *(Measured 2026-11-12, the owner's eight sessions on beta.44: both calls were read in six of six Streamline sessions on five games — Unreal's Streamline plugin asks again after the attach, Cyberpunk 2077 asks again for requirements and not for versions. A game that asks only while starting still reads "hooked, not asked again".)* Three conditions before a read, as for `slSetConstants`: the Agent is asking, observing has not stopped, and the struct carries its own GUID and a version of at least 1 on this call (a struct with another GUID is not kept: the injected case sends one). Every member read is version 1's (§Which struct version carries which field). **Twelve slots** in region 5 (`FlAdvancedState.features`, layout 5 as it was), one per feature in the order first asked about; the last answer about a feature is the one kept; a thirteenth feature is not kept. **A new request does not empty them**: what version a feature is and what it requires are facts about the process, and a second session of a game that kept running would otherwise have nothing where the first had the answer — the one group `Reset` leaves, with its bit of the mask. Streamline 1.x is refused before anything is resolved (`SpeaksStreamline2`). Families `FL_HOOK_SL_FEATURE_VERSION` (bit 15) and `FL_HOOK_SL_FEATURE_REQUIREMENTS` (bit 16), each published with its patch; neither entitles a field of a frame record. **Measured overhead** (the detours' bodies on the headers, the Overlay's flags, 20 million calls a run, three runs, eight features asked about in turn): the version — not asked **+0.58 / +0.61 / +0.58 ns**, asked **+14.82 / +14.54 / +14.47 ns**; the requirements — not asked **+0.58 / +0.63 / +0.61 ns**, asked **+20.88 / +21.01 / +20.96 ns**. A game makes these calls a handful of times. |
|
||||
| ✅ Streamline: `slIsFeatureSupported`, `slIsFeatureLoaded`, `slSetFeatureLoaded` (0.1.0-beta.45; owner decisions D129–D131) | **Whether a feature is supported, whether it is loaded, and the game switching it on and off.** Three rows, three patches. Rule 4: bare arguments and results of the calls hooked, and no vendor struct at all — the feature's id; the `sl::Result` `slIsFeatureSupported` returned, **every result**, since a refusal is the answer to that question (the original runs first, both arguments forwarded untouched); the `bool` `slIsFeatureLoaded` wrote, read only when it returned `eOk`; the `bool` the game passed to `slSetFeatureLoaded`, noted before the call. **The adapter `slIsFeatureSupported` is asked about is never read** (D131): `sl::AdapterInfo` holds the adapter's LUID or a Vulkan physical device; the detour forwards the reference and `tools/overlay-fields-check.ps1` refuses the names of its members (`deviceLUID`, `deviceLUIDSizeInBytes`, `vkPhysicalDevice`) anywhere in the Overlay and the Vulkan layer — the fixture's adapter carries a wild pointer. **Installed only where asked for** (D111), as the four rows before them. `slIsFeatureSupported` and `slIsFeatureLoaded` follow the two rows of beta.44 at the head of the table; `slSetFeatureLoaded` follows `slSetConstants`. **Kept in word 1 of the feature's slot** (region 5, layout 5 as it was): bit 2 and the result in bits 8..15, bits 3 and 4, bits 5 and 6 — the last two a session's, cleared by a new request; the rest the process's, kept (`fl_adv_fields.h` `kFeatureSessionBits`). A refused feature therefore has a slot now, with nothing in it but that word. The declarations of the three functions are the same from Streamline v2.0.0 to v2.14.16, and `sl::Result` is the same forty codes in the same order at all sixteen tags (`include/sl_result.h`, `05a3c7e3889c` … `8a844b68ff55`), so a code means the same whatever interposer answered. Families `FL_HOOK_SL_FEATURE_SUPPORTED` (bit 17), `FL_HOOK_SL_FEATURE_LOADED` (18), `FL_HOOK_SL_SET_FEATURE_LOADED` (19), each published with its patch. **Measured overhead** (the detours' bodies on the headers, the Overlay's flags, 20 million calls a run, three runs, eight features in turn): `slIsFeatureSupported` — not asked **+1.50 / +1.48 / +1.50 ns**, asked **+11.97 / +11.98 / +12.08 ns**; `slIsFeatureLoaded` — **+1.79 / +1.77 / +1.89 ns**, **+12.35 / +12.31 / +12.33 ns**; `slSetFeatureLoaded` — **+1.44 / +1.47 / +1.80 ns**, **+11.28 / +11.54 / +11.45 ns**. **`slInit` is not a row and will not be** (D129): a game calls it once, before the Overlay is in the process or before a patch can land — launch mode waits for the presentation runtime before it injects, nothing is ever patched on a game's thread (§H2), and a row that exists only for Advanced metrics waits for the Agent's request. **A stop takes about 160 ms for every patch it restores** (measured on the fixture, 0.1.0-beta.45: each `MH_DisableHook` snapshots the system's threads): twelve patches took 1.9 s, fifteen 2.4 s, and the watchdog's wait for the stop's log lines, 2 s until then, is now a quarter of a second for every patch the registry can hold. **Since 0.1.0-beta.46 (D134) a stop restores its patches under one stop of the threads**: eighteen in 76–90 ms on the fixture, where one by one they took 1.37–1.56 s (§Unhooking, Batches). |
|
||||
| ✅ Streamline: `slAllocateResources`, `slFreeResources`, `slShutdown` (0.1.0-beta.45; owner decision D130) | **The game allocating and freeing a feature's resources, and shutting Streamline down — counted, and nothing else.** Three rows, three patches. Rule 4: the feature's id is the only argument looked at; the command buffer and the viewport of the two resource calls are forwarded and never read (the fixture's command buffer is a wild pointer), and `slShutdown` has no argument. **`slFreeResources` and `slShutdown` are on a game's way out**: each detour notes the call first and then calls the original, exactly once, and runs nothing of ours after it returns; the fixture goes on calling the stub after `slShutdown`, through every detour. **Installed only where asked for** (D111); the last three Streamline rows of the table. **Kept** in word 1 of the feature's slot as two four-bit counts — allocations in bits 16..19, frees in 20..23, each stopping at 15 and never carrying into its neighbour — and, for `slShutdown`, in `FlAdvancedState.slShutdowns` (@308, the first of three reserved words; layout 5 as it was) with `FL_ADV_VALID_SL_SHUTDOWN` (bit 6 of the mask). All three are a session's: a new request clears them. Families `FL_HOOK_SL_ALLOCATE_RESOURCES` (bit 20), `FL_HOOK_SL_FREE_RESOURCES` (21), `FL_HOOK_SL_SHUTDOWN` (22). The three declarations are the same from Streamline v2.0.0 to v2.14.16. **Measured overhead** (the detours' bodies on the headers, the Overlay's flags, 20 million calls a run, three runs): `slAllocateResources` — not asked **+0.70 / +0.72 / +0.80 ns**, asked **+10.43 / +10.53 / +10.74 ns**; `slFreeResources` — **+0.61 / +0.84 / +0.58 ns**, **+10.33 / +10.57 / +10.44 ns**; `slShutdown` — not asked within the bench's noise (+0.06 / −0.12 / +0.04 ns), asked **+3.39 / +3.37 / +3.52 ns**. Inventory 23 → 26 rows; a Streamline title with Advanced metrics asked for now carries thirteen patches on the interposer, and a stop restores each in about 160 ms (the row above). **In real games (2026-11-13: six sessions, five games)** `slAllocateResources` was not called once after the attach, `slFreeResources` once in one game (Phantom Blade Zero, frame generation's) and `slShutdown` once in one (Dying Light: The Beast); no session counted a fault, and the two games that fault while closing did so at the offsets they had before these hooks. Installing the thirteen interposer patches took 0.7 s to 2.8 s of a game's start, 57 to 215 ms a patch. The owner's word on both (2026-11-13): `slAllocateResources` keeps its patch and is looked at again with more sessions (D135); installs and restores are to be batched, one stop of the threads for a batch (D134, 0.1.0-beta.46). |
|
||||
| ✅ Streamline: `slSetTag` — **and, since 2026-09-05, every tag's TYPE** (`slTagCensus`; a HUD-less / UI tag marks the present `FL_FG_DLSS_G`, rule 4: the same argument) | The **global** resource tags, where a title states the size of the buffer it is upscaling *from*: `kBufferTypeScalingInputColor`'s extent → `renderW/H` — **or, since 2026-09-05, the size the tagged `sl::Resource` declares when the extent is zero** (`TagSize` in `fl_sl_inputs.h`, shared by all three tag routes; GUID-checked; a Resource declaring no size is still the honest unknown). **Built 2026-08-15** (`FL_HOOK_UPSCALER_PARAMS`), and it is an ALTERNATIVE to the local tags in `slEvaluateFeature`'s `inputs`, not a layer over them — `sl_core_api.h:258` says global and local tags "do NOT interact", so a title using one yields nothing from the other and both are read. Published only on a frame where an evaluation was also seen, because a tag is viewport state that outlives any one frame. This row was MISSING from this table while the hook shipped, which is the gap the banner above now names |
|
||||
| ✅ Streamline: `slSetTagForFrame` — **and every tag's TYPE, as above** | The same global tags through **Streamline 2.8's frame-based entry point**, which deprecates `slSetTag`: `(const FrameToken&, const ViewportHandle&, const ResourceTag*, uint32_t, CommandBuffer*)` — the token first, then exactly `slSetTag`'s list, handed to the same tag walk. **Built 2026-09-04** (`FL_HOOK_UPSCALER_PARAMS`, its own trampoline; the family is now **published when whole** — once every tag export the loaded interposer has is patched — because publishing on the first row entitled records the second was not yet producing, 38 of 41 on the fixture: the ffx leaves' #110 defect again, fixed the same way). Measured need: Dying Light: The Beast (SL 2.8.0) published `Dlss` identity on every batch and the params bit on none across three captures, because a 2.8 title that tags per frame never calls the deprecated export. The token is not read; the frame count stays with `slGetNewFrameToken`. The installer picks this detour by SYMBOL (`kSymbolSlSetTagForFrame`, bound to the row by `static_assert`), not by family, since the two rows share a family bit and differ in signature |
|
||||
| ✅ **FidelityFX ffx-api: `ffxDispatch` on the FOUR modules a game calls** — `amd_fidelityfx_dx12.dll` (SDK 1.1.x monolith), `amd_fidelityfx_upscaler_dx12.dll`, `amd_fidelityfx_framegeneration_dx12.dll`, **and `amd_fidelityfx_loader_dx12.dll`** (added the evening of 2026-09-04: three loader-shipping titles at FSR produced zero dispatches at any leaf export, so the loader is where their calls arrive) · ⏳ FSR 3.0 host route `ffx_fsr3_x64.dll!ffxFsr3ContextDispatchUpscale` / `ffxFsr3DispatchFrameGeneration` · ~~`ffxFsr2ContextCreate`~~ · ~~`ffxCreateContext`~~ | **Built 2026-09-04** (`HANDOFF` item 7c). One observer behind three trampolines reads the DESCRIPTOR the title passed — head type first, body only after the type matched a constant from the vendored MIT headers (`third_party/fidelityfx/`, tag v2.3.0): **UPSCALE** → identity (`FSR3` from the monolith, `FSR_UNVERSIONED` from the 2.x upscaler DLL, which hosts FSR 3.1 and FSR 4 behind one type) + `renderSize` → `renderW/H` (quality and sharpness `0xFF`: the dispatch carries neither — *since beta.25 the quality byte is the mode the `ffxQuery` row below names for the dispatched size, `0xFF` when none does*) + one COUNT *(since 0.1.0-beta.43, owner decision D125: **counted at the first source that saw an UPSCALE and at no other** — `g_ffxUpscaleOwner`, `fl::adv::Owns`. Cyberpunk 2077's loader 2.3.0 hands a dispatch on to the leaf's export — its frame-generation dispatch types are logged on the loader and on the leaf — so an UPSCALE through such a loader reaches two hooked modules, and one count per module read K = 1 as 2.0 on the fixture bound that way (`--ffx-topology 2x-export`: 60 presents, 120 counted). No title run so far upscales through one; it is a precaution. Measured on the header with the Overlay's flags: +0.02 to +0.03 ns on the module that is counted, about 4 ns less on the forwarded copy)*; **PREPARE / PREPARE_V2** → `frameID` counted on a *new* index only — this vendor's `slGetNewFrameToken`, the `fgEvaluations` producer once a title has ever prepared, with the UPSCALE count as the fallback for a title that never does; **FRAMEGENERATION** → `fgMode = FSR_FG` on that present. Rule 4: the argument of the API we hooked, never `context`, `pNext`, a command list or a resource. **Why all four:** a UE5 title ships the two leaves with no loader and calls their exports; a loader-shipping title calls the loader's export and the signed loader reaches its providers through an object, not the leaves' exports (measured: Dying Light: The Beast, KCD2, Wukong). The morning's "never the loader" rested on the export tables alone and was reversed by the run. What guards against a loader that DID re-enter a leaf's export is the K = 1 control with all four hooked and the consumer's `frames/upscale-drained`, both of which read 2× in that case. `ffxCreateContext` is deliberately NOT a row — nothing it carries fills a field the dispatch does not, and its honest family would collide with `slEvaluateFeature`'s under the installer's equality binding. The family is compound (`IDENTITY \| PARAMS \| FG_EVALUATIONS`), pinned by `static_assert`s that also bind the leaf table to the rows both ways and refuse the loader as a row. Streamline keeps precedence for the count once it has ever issued a token, so every §S31-validated title is byte-identical. Second count: the consumer prints `frames/upscale-drained`, the AMD `tokens/batch`. **FSR 3.0 — BUILT 2026-09-05 as a fifth AMD target:** `ffx_fsr3_x64.dll!ffxFsr3ContextDispatchUpscale` (Cyberpunk's copy; named export, its own descriptor, vendored from tag **`fsr3-v3.0.4`** — the tag whose twelve `ffxFsr3*` declarations match the shipped module, not the `v1.1.4` first named). Rule 4: the detour reads `renderSize` of the descriptor the title passed and nothing else — never the context, a resource or the command list; the offset is pinned to a literal (1256) so a re-vendoring that moved it fails to compile. Same family and publish point as the four rows (`PublishFfxFamilyIfWhole` waits for a loaded host too), keyed by module in the installer; identity `FSR3` as a fact. `ffxFsr3DispatchFrameGeneration` is deliberately not a row (§H11 carries the reversal condition); the `ffx_fsr3upscaler_x64.dll` leaf is the pre-committed alternative if the facade reads silent (row B2) — never both, or `frames/upscale-drained` reads 2.00. **Since 0.1.0-beta.40 (Advanced metrics train B, D111), and only while the Agent asks:** the UPSCALE arm reads the rest of `ffxDispatchDescUpscale` — `enableSharpening`, `sharpness`, `jitterOffset`, `preExposure`, `cameraNear`, `cameraFar`, `cameraFovAngleVertical`, `flags`, `reset`, `frameTimeDelta` — into process-local summaries (an "ever seen" mask, a largest magnitude, a lowest and highest, a count and a sum; one module's dispatches are counted, so a dispatch that reaches the loader and a leaf is one). Never on the FSR 3.0 host's legacy descriptor, which is vouched Line truncated
|
||||
@@ -405,7 +480,7 @@ or version, so the question is whether the declaration ever changed:
|
||||
| Hook / call | Yields |
|
||||
|---|---|
|
||||
| ~~`IDXGIAdapter3::QueryVideoMemoryInfo` (we **call** it, not hook it, once per second from our own thread)~~ | ~~**Per-process VRAM** `CurrentUsage` + `Budget` — previously impossible; now exact~~ **Never built; superseded 2026-10-03 (D43):** the game's memory is read from OUTSIDE the game by the Agent (`18_GPU_VENDOR_APIS` §The game process's memory), so nothing in the Overlay calls it. Only the budget would need it, and that stays open (`20_OPEN_QUESTIONS` §M11) |
|
||||
| NVAPI Reflex: ~~hook `NvAPI_D3D_SetSleepMode`, `NvAPI_D3D_SetLatencyMarker`~~; call `NvAPI_D3D_GetLatency` *(**never built.** The two hooks cannot be: neither function is an export — `20_OPEN_QUESTIONS` §M14. What a call-only route would take is read through in `spike-notes` §30, 2026-11-12, and waits for the owner's go or no)* | Reflex on/off + PC latency breakdown. Declarations come from the vendored MIT NVAPI headers (`18_GPU_VENDOR_APIS` §L3); the Overlay links them like any other header. NVIDIA-only — the whole block compiles out to a no-op capability flag elsewhere |
|
||||
| NVAPI Reflex: ~~hook `NvAPI_D3D_SetSleepMode`, `NvAPI_D3D_SetLatencyMarker`~~; call `NvAPI_D3D_GetLatency` and `NvAPI_D3D_GetSleepStatus` *(the two hooks cannot be: neither function is an export — `20_OPEN_QUESTIONS` §M14. **The calls are made since 0.1.0-beta.47** — §Calls the Overlay makes into a driver, above; owner decisions D132, D136)* | Reflex on/off + PC latency breakdown. Declarations come from the vendored MIT NVAPI headers (`18_GPU_VENDOR_APIS` §L3); the Overlay links them like any other header. NVIDIA-only — the whole block compiles out to a no-op capability flag elsewhere |
|
||||
|
||||
### Explicitly not hooked
|
||||
Input APIs, file I/O, network, memory allocators, window messages beyond what the overlay needs, anything game-specific. Rule 4 in CLAUDE.md.
|
||||
@@ -582,9 +657,11 @@ static_assert(sizeof(FlFrameRecord) == 64);
|
||||
> v3 makes it safe by CONSTRUCTION. Every enum's 0 is now `NOT_REPORTED`, and
|
||||
> `rtFlags`' polarity is flipped so its bits mean *observed*.
|
||||
>
|
||||
> Four answers items 4/6/7 owe had no home and now do: DLSS-SR **and** Ray
|
||||
> Reconstruction concurrently (`featureFlags`, since RR was a mutually exclusive
|
||||
> `upscaler` value), `upscalerSharpness`, and — in `FlWriterState`, because they
|
||||
> Four answers items 4/6/7 owe had no home and now do: DLSS **with** Ray
|
||||
> Reconstruction (`featureFlags`, since RR was a mutually exclusive
|
||||
> `upscaler` value — *corrected 2026-11-14: this said "DLSS-SR and Ray
|
||||
> Reconstruction concurrently"; RR runs instead of super resolution, it is still
|
||||
> DLSS*), `upscalerSharpness`, and — in `FlWriterState`, because they
|
||||
> are session facts and not per-frame — the device **RT tier** without which
|
||||
> `03_METRICS`' definite RT `No` had no producer at all, plus `rtStateObjectsCreated`
|
||||
> and `rasterPsoCreated`.
|
||||
@@ -650,7 +727,7 @@ Field notes — each of these was a defect in an earlier revision:
|
||||
header — they are written by the other process, and mixing them into an
|
||||
Overlay-written line reintroduces exactly the false sharing the split exists to
|
||||
prevent. Layout is normative in `07_IPC` §A + B.
|
||||
- **The hot path performs: one QPC read, a few field reads from cached state, one 60-byte store, two relaxed atomic stores and two compiler fences.** No syscall, no allocation, no lock, no logging. Target ≤ 1 µs per present. *(Added 2026-10-04: the summary leaves out the per-present `IDXGISwapChain::GetLastPresentCount` call (§H5, the `dxgiUnseen` count) and the display sample every 500 ms at most (region 4).)*
|
||||
- **The hot path performs: one QPC read, a few field reads from cached state, one 60-byte store, two relaxed atomic stores and two compiler fences.** No syscall, no allocation, no lock, no logging. Target ≤ 1 µs per present. *(Added 2026-10-04: the summary leaves out the per-present `IDXGISwapChain::GetLastPresentCount` call (§H5, the `dxgiUnseen` count) and the display sample every 500 ms at most (region 4).)* *(Added 2026-11-13, train C, 0.1.0-beta.47: after the store, one relaxed load of the latency gate; and, while a session asks for Advanced metrics and the watchdog armed one, a call into the driver about once a second — §Calls the Overlay makes into a driver. That call is the one thing on this path that is not bounded by FrameLedger's own code: 0.5–2.6 µs measured against the installed driver, and a call of 2 ms or more is the last.)*
|
||||
- Per-frame mutable state (current upscaler, render res, dispatch counts) lives in a small struct updated by the feature hooks and *read* by the present hook; counters reset at present.
|
||||
|
||||
## The watchdog thread — the only thread we add to the game
|
||||
@@ -714,8 +791,9 @@ Every hook body is wrapped:
|
||||
```
|
||||
|
||||
- Any SEH exception inside our code ⇒ increment `faultCount`, record which hook, **return control to the original function** so the game continues.
|
||||
- 3 faults total ⇒ set `status = self_disabled`, ~~uninstall all hooks (`MH_DisableHook(MH_ALL_HOOKS)`)~~ restore each patch's prologue only while its bytes are still our jump (compare-and-restore per patch through `StopObserving`, §Unhooking, §H7 — `MH_ALL_HOOKS` would have removed an overlay chained after us; corrected 2026-09-27), stop writing, stay dormant. The Agent sees the flag and finalizes the session as `degraded`.
|
||||
- 3 faults total ⇒ set `status = self_disabled`, ~~uninstall all hooks (`MH_DisableHook(MH_ALL_HOOKS)`)~~ restore each patch's prologue only while its bytes are still our jump (compare-and-restore per patch through `StopObserving`, §Unhooking, §H7 — `MH_ALL_HOOKS` would have removed an overlay chained after us; corrected 2026-09-27; since 0.1.0-beta.46 the patches that are still ours come out together, under one stop of the threads — §Unhooking, Batches), stop writing, stay dormant. The Agent sees the flag and finalizes the session as `degraded`.
|
||||
- Never `__try` around the call to the original function — only around *our* code, so we never mask a game bug as ours or vice versa.
|
||||
- **One exception, since train C (2026-11-13): the two driver getters the Overlay calls itself** (§Calls the Overlay makes into a driver) are under a guard of their own, `fl_reflex.h`'s, with the same filter. They are not "the original function" — the game did not make these calls, we did, so a fault in them is ours to answer for. It is counted once through `NoteFault`, and the read is switched off for the process in the same breath, so that one fault cannot become the three that self-disable. **A caught fault does not give back a lock the driver held**: the guard is containment, not safety, which is why nothing is called again after it.
|
||||
- The trampoline call to the original is always executed exactly once, on every path, including error paths.
|
||||
|
||||
## Unhooking
|
||||
@@ -761,6 +839,67 @@ Every hook body is wrapped:
|
||||
> the shipped sequence against real MinHook patches: a full registry leaves the target's bytes untouched and
|
||||
> MinHook unasked; a stop arranged between the enable and the re-read ends with the function unpatched; a failed
|
||||
> patch gives its slot back; a slot is invisible to the walk until committed.
|
||||
>
|
||||
> **Batches, 0.1.0-beta.46 (owner decision D134): one stop of the game's threads for a group of patches.** MinHook
|
||||
> writes a jump with every other thread of the process stopped — a snapshot of the system's threads, then a
|
||||
> suspend, a context read and a resume for each of the process's — and `MH_EnableHook` / `MH_DisableHook` for one
|
||||
> target do all of that for one jump. The owner's logs of 2026-11-13 put a number on it: the thirteen Streamline
|
||||
> patches took 0.74 s to 2.8 s of a game's start, 57 to 215 ms each, and a stop restored its patches the same way.
|
||||
> MinHook 1.3.4 can queue — `MH_QueueEnableHook` / `MH_QueueDisableHook` mark a hook, `MH_ApplyQueued` executes
|
||||
> every mark under one stop — and `fl_patch_registry.h` now has the two sequences that use it:
|
||||
> `fl::patch::Batch` (`Add`: slot and create, nothing marked; `Commit`: enable them all) and
|
||||
> `fl::patch::RestoreAll`, which is the stop's walk. `InstallUpscalerHooks` queues every row a tick finds
|
||||
> something for and commits once, before the families that are published "when whole"; `InstallRtHooks` batches
|
||||
> its two; `StopObserving` calls `RestoreAll`. A patch's `HOOK_INSTALLED` line, family bit and latch still come in
|
||||
> that order and only once it is in. The loader detour, OpenGL and the three DXGI patches of init are as they were.
|
||||
>
|
||||
> **What the queue makes dangerous, and what the code therefore never does** (the plan was reviewed against
|
||||
> `hook.c` before a line was written, and its first form was refused). `MH_ApplyQueued` applies **every** hook
|
||||
> whose mark differs from its state — the process has one table, not one per caller. So (1) **no mark is ever left
|
||||
> standing**: a hook that failed to enable has its mark removed, or the next apply — the stop's own — would enable
|
||||
> it; (2) **only a patch that is still ours is ever marked for a restore** (`StillOurs`, as before; §H7), and
|
||||
> nothing is marked "all" — the refused draft marked everything and then un-marked what it must not restore, and
|
||||
> un-marking a hook that is already out marks it for *enabling*: the stop would have put a patch back in after the
|
||||
> stop; (3) **mark, apply and commit happen inside a gate** (`MinHookEngine::BeginQueue`, a slim lock taken
|
||||
> exclusively) so the watchdog's apply cannot execute the stop's marks nor the stop's the watchdog's. The gate is
|
||||
> held for one apply and never across a symbol lookup, which takes the loader's lock. It is the one lock in the
|
||||
> Overlay, and it is on no hook body's path: the only way from a hook to it is the stop itself, which already
|
||||
> waited for MinHook's own lock and a stop of the threads for every patch. Its owner re-enters it without
|
||||
> waiting. **The verdict on an install is the engine's, not the bytes'**: a foreign overlay patching over us a
|
||||
> moment after the apply would read as "not in", and treating that as a failure would mark a restore nobody had
|
||||
> compared. `MH_ApplyQueued` stops at the first hook that fails and says only that one did; the ones after it
|
||||
> are then enabled — or, in the stop, restored — one at a time, so one bad patch still costs one patch.
|
||||
> The write-then-read pair is unchanged: the stop clears the flag and then walks; `Commit` commits its slots and
|
||||
> then re-reads the flag, and takes out — compared first — what it put in when the flag is clear. A stop that
|
||||
> lands before the commit enables nothing.
|
||||
>
|
||||
> **Measured** on `hook-harness`'s Streamline target, the development PC, three runs before and after (`fl_guard`
|
||||
> `[advanced]` prints them): the nine Advanced-only patches went in one by one over 0.60 s / 0.70 s / 0.60 s
|
||||
> from the first log line to the ninth, 76–88 ms each; as one batch they take **81 / 90 / 78 ms**. The stop restored
|
||||
> eighteen patches in 1.37 s / 1.56 s / 1.37 s; under one apply, **77 / 90 / 76 ms** — and from the Agent's request
|
||||
> to `UNHOOKED`, 1.27–1.48 s became 94–110 ms. One stop of the threads costs what it cost for one patch, whether it
|
||||
> covers four, nine or eighteen. A new log line says so in the field: `PATCH_BATCH install` / `restore`, `a` the
|
||||
> microseconds, `b` the patches. ~~**Not measured:** a real game — how long one stop of the threads is with a few
|
||||
> hundred of them, and whether any title minds patches arriving together (owner-only item 44).~~ **In real games**
|
||||
> (the owner's five sessions of 2026-11-13 on 0.1.0-beta.46 — Hogwarts Legacy, Phantom Blade Zero, Black Myth:
|
||||
> Wukong, Cyberpunk 2077, Clair Obscur: Expedition 33; eighteen install batches of two to sixteen patches): every
|
||||
> batch went in whole, with the hooks beta.45 installed and no `PATCH_FAILED`; **sixteen batches cost 81–262 ms
|
||||
> whatever they held**, which is what one patch cost in the same game before. Streamline's thirteen, first line to
|
||||
> last on beta.45 against the one batch now: Phantom Blade Zero 0.74–0.85 s → 88 ms, Cyberpunk 2077 1.18 s → 93 ms
|
||||
> (with three more patches in the batch), Black Myth: Wukong 1.65 s → 188 ms (twelve), Hogwarts Legacy 2.80 s →
|
||||
> **1.26 s**. That last one and a batch of three in Cyberpunk 2077 (**0.61 s**) are not explained: the cost does
|
||||
> not follow the count — sixteen patches in 93 ms, three in 609 ms — and **the log cannot tell one long stop from an
|
||||
> apply that failed part-way and was finished one patch at a time**, because a batch writes a line only for a patch
|
||||
> that fails for good. **Since 0.1.0-beta.47 the line says which** (owner decision D137): `install` or `restore` is a batch that went under its one apply; `install singly` or `restore singly` is one whose apply said it had failed, and the high half of `b` then counts the patches handed to MinHook one at a time (`b=0x0003000d`: thirteen in, three of them singly) — attempts, not stops: MinHook makes no stop for a patch the failed apply had already done. So a long `a=` on a plain `install` line is one long stop of the threads. ~~**Still not measured: the restore in a real game**~~ **The restore in a real game** (the owner, 2026-11-14,
|
||||
> Phantom Blade Zero, twice): twenty-nine patches out under one apply of **83 ms and 86 ms**, every one restored,
|
||||
> none declined, and the game went on for minutes and closed cleanly (owner-only item 44 (d)). One more thing the
|
||||
> queue changes for the better: MinHook's single-target disable does not move a thread that is suspended inside
|
||||
> the patched bytes (`hook.c` passes the enable action to its thread fix-up in both directions); the queued apply
|
||||
> does. ctest `fl_unhook_inline` drives `Batch` and `RestoreAll` against real MinHook (three in under one apply,
|
||||
> a duplicate target refused without holding the others up, a foreign patch left byte for byte) and against a
|
||||
> model of MinHook's table for what real MinHook cannot be made to do on demand: an apply that fails halfway or
|
||||
> not at all, a stop inside the apply, a committed patch that is already out — the refused draft's failure — and
|
||||
> that no mark is ever standing or made outside the gate.
|
||||
|
||||
~~`FlRequestUnhook()` (or the control flag) ⇒ `MH_DisableHook(MH_ALL_HOOKS)`, restore vtable entries **only where they are still ours**, flush the ring, set status.~~ *(Corrected 2026-10-04: both reach `StopObserving` — compare-and-restore per patch as the note above says, then the status; there is no `MH_ALL_HOOKS`, no vtable entry and no ring flush. The watchdog flushes the native log on its way out.)* **The DLL is not `FreeLibrary`'d from the live process** — a thread could still be inside a trampoline. It goes dormant and unloads with the process. This is deliberate and documented.
|
||||
|
||||
@@ -789,6 +928,12 @@ before it. And when the slot has changed, going dormant costs nothing: we stay
|
||||
loaded anyway, and our detour remains in someone else's chain doing nothing
|
||||
harmful.
|
||||
|
||||
> **Said plainly, 2026-11-13: for the inline patches that re-check has never been made.** MinHook owns the write
|
||||
> window — it stops the threads, changes the protection and writes — and `StillOurs` is asked before it is called,
|
||||
> not inside. Between the two a foreign overlay could patch over us, on a thread MinHook has not stopped yet. The
|
||||
> batches of 0.1.0-beta.46 neither close that window nor widen it: the comparison and the write are apart by one
|
||||
> stop of the threads, as they were for each patch, once instead of once a patch.
|
||||
|
||||
Verified by `hook-harness --probe-unhook` (ctest `fl_unhook_preserves_foreign`),
|
||||
which simulates the foreign hooker rather than depending on RTSS being
|
||||
installed, so it is deterministic and runs on CI. Both halves are asserted: we
|
||||
@@ -810,7 +955,30 @@ No logging in hook bodies. A small fixed-size in-memory ring of structured event
|
||||
> writing), and since beta.42 `PATCH_FAILED` (a patch that did not go in, once per target and reason — §Unhooking)
|
||||
> and `FFX_DISPATCH`, `FFX_QUERY`, `UPSCALE_ROUTE`, `RUNTIME_CENSUS` (the note at the end of this section), and
|
||||
> since beta.43 `FFX_CONFIGURE` — each configure type a hooked ffx module was handed, in a process where
|
||||
> `ffxConfigure` is hooked at all (one asked for Advanced metrics).
|
||||
> `ffxConfigure` is hooked at all (one asked for Advanced metrics) — and since beta.46 `PATCH_BATCH`: one line an
|
||||
> apply, `install` or `restore`, `a` the microseconds it took and `b` the patches it covered (§Unhooking, Batches).
|
||||
> **`LATENCY` (train C, 0.1.0-beta.47)**: one line each time the state of the driver read changes — `a` the
|
||||
> `FlLatencyState`, the text what it means — and, when the module is found, two more with the end of the path
|
||||
> `nvapi64.dll` was loaded from and of the image its getters are in. Written by the watchdog; a fault in a getter
|
||||
> is a `FAULT` line from the presenting thread, as any fault is.
|
||||
> **`LATENCY_FRAMES` (0.1.0-beta.49, owner decisions D148, D151)**: the frames the driver reads summed, counted
|
||||
> for this log and nowhere else — nothing of it is published, stored or shown. Each summed frame is placed by its
|
||||
> own two numbers, the span between its two GPU marks and the driver's active render time: no start mark, a span
|
||||
> of no length, an active time with no span, a span with no active time, and — where a frame has both — *active
|
||||
> longer than the span* or *active within the span*, each with its count and both sums in microseconds. No
|
||||
> threshold: a span of one microsecond is a span. **A batch is seven lines and belongs to one state of the driver's
|
||||
> sleep status** — its low-latency switch, its "the game sleeps" switch and its frame-generation multiplier —
|
||||
> because the counts mean nothing apart from it: a read in another state closes the batch first (thirty-two such
|
||||
> closings a request, after which a batch runs to its length and its first line says what it held). A batch is
|
||||
> also written after a request's tenth read, its thirtieth and every sixtieth from there, when the Agent asks for
|
||||
> a flush, at a new request and at a stop. `a` is printed in decimal and `b` in hex: *reads* and the switches
|
||||
> seen on, off (`<<8`) and the multipliers seen (`<<16`); *frames summed* and refused; *GPU span absent* and of no
|
||||
> length; *active time with no span* and span with no active time; then the two heaps, `a` their frames and `b`
|
||||
> their span sum (`<<32`) and active sum; and the watchdog's own line — the *milliseconds the batch spans* and its
|
||||
> ticks in them, on time (`<<32`) and woken early: a read a second is a thousand milliseconds a read and as many
|
||||
> periodic ticks as reads (D150). **A game that exits by itself takes the batch in hand with it** — under a
|
||||
> minute of reads. About seven lines a minute while a session with *Advanced metrics* reads the driver; none
|
||||
> otherwise.
|
||||
> **Three flush points — four since beta.42, the same note —, none on a present path:** the end of `InitThread` (so the
|
||||
> file exists from the start of the session and a crash mid-session still leaves it), the watchdog when
|
||||
> `FlControlBlock.logFlushRequested` changes (a counter the Agent bumps at session end; nothing clears it),
|
||||
@@ -822,7 +990,7 @@ No logging in hook bodies. A small fixed-size in-memory ring of structured event
|
||||
> it reads 0. When the stop ran on a presenting thread — `MayObserve`'s one-frame safety stop — the watchdog's one
|
||||
> final flush could run while that thread was still writing, and the lines after it (the kernelbase loader detour is
|
||||
> the last patch) reached the ring after the last flush ever made. The stop now says when its last line is in, and
|
||||
> wakes the watchdog; the final flush waits for that, bounded at 2 s, then writes `STOP_FLUSHED`. And each slot has a
|
||||
> wakes the watchdog; the final flush waits for that, bounded at 2 s *(a quarter of a second for every patch the registry can hold since beta.45; the stop is one apply since beta.46 and the bound is for its fallback)*, then writes `STOP_FLUSHED`. And each slot has a
|
||||
> commit word written after its fields: `LogNote` claims a slot with one `fetch_add` and fills it afterwards, so a
|
||||
> flush on another thread could print a slot still being filled. A flush now prints only slots whose writer has
|
||||
> finished — an ordinary flush stops at the first that is not, for the next one; the final flush names it in a `#`
|
||||
|
||||
+57
-17
@@ -724,7 +724,7 @@ Rules 4 and 5, the hook inventory, the measured overhead and the anti-cheat guar
|
||||
every hook. `sl::Constants` is read without its camera position, axes and matrices: where the camera is, is where the
|
||||
player is (rule 4). NGX stays closed by its licence (`17_HOOK_ENGINE` §NGX).
|
||||
|
||||
**Train D re-examines a refusal; it does not lift it.** `handoff/history/p0-queue-1-6.md` refused, on five grounds,
|
||||
**Closed 2026-11-14 (owner decision D154): train D is not built, and the refusal stands.** The ten entries it would have read — what a game sets and asks through Streamline's feature functions — have reach `RefusedRoute`: seeing those calls takes handing the game a function of FrameLedger's in place of Streamline's, and a game that fetched its functions before the attach would never call it. What follows is the plan as it stood. **Train D re-examines a refusal; it does not lift it.** `handoff/history/p0-queue-1-6.md` refused, on five grounds,
|
||||
hooking `slGetFeatureFunction` and patching the function it returns. The route to try is a different one:
|
||||
`slGetFeatureFunction` is itself an export (`vendor-exports.json`), so its hook is an ordinary inventory row, and
|
||||
what it hands back could be a wrapper for a fixed list of names instead of a patch at an address learned at run time
|
||||
@@ -811,6 +811,10 @@ planning, the design reviewed against the code before it was approved.
|
||||
row written before; the page says the six in one sentence. The switching and the counts are a session's — the
|
||||
capture side clears them at a new request — so, unlike the answers, a second session does not inherit them.
|
||||
`sl.init.preferences` now has reach `BeforeAttach` (D129): not a later release, never.
|
||||
**Measured 2026-11-13** (six Streamline sessions on five games; `HANDOFF` item 43): `slIsFeatureSupported` was
|
||||
read in every one — refusals among the answers, `eErrorFeatureMissing` for ImGUI, NIS and DeepDVC —
|
||||
`slIsFeatureLoaded` in three games, `slSetFeatureLoaded` in two (every feature off and on), `slFreeResources`
|
||||
and `slShutdown` once in one game each, and `slAllocateResources` in none.
|
||||
- **D113 — three releases, because a new patch site cannot be proven in CI.** A crash in a game under the user-mode
|
||||
anti-cheat exception's trial ends that exception for good (D38), and every release already means restarting the
|
||||
game. **beta.40**: more fields of calls *already* hooked — `sl::DLSSOptions` where the game chains it into
|
||||
@@ -868,6 +872,17 @@ planning, the design reviewed against the code before it was approved.
|
||||
- **Privacy Policy 2.18** at beta.44 (approved with that release's plan): 2.17 named two further calls and what
|
||||
they give; Streamline's answers about a feature are in neither list, so they are named, with what of the answer
|
||||
is never read — the lists it points to.
|
||||
- **Privacy Policy 2.21 and Disclaimer 2.17** at beta.48 (wording approved with the plan of 2026-11-14, D145):
|
||||
the Privacy Policy names the two further averages a session stores of the driver's report and that the
|
||||
frame-generation multiplier is every value the session saw; the Disclaimer changes only with the accuracy
|
||||
statement it carries, which now says two real games were read, that the stages overlap, and that the graphics
|
||||
card's stage includes its waiting. No new call: the paragraph on the call the component makes is as it was.
|
||||
- **Privacy Policy 2.20 and Disclaimer 2.16** at beta.47, train C (wording approved with the plan of
|
||||
2026-11-13): the first thing read inside a game that is **not an argument of a call the game made**. The Privacy
|
||||
Policy names what is stored — how long each stage of a frame took, as the driver reports it, and the driver's
|
||||
low-latency state; never a time of day, never an input's moment. The Disclaimer drops "API arguments and nothing
|
||||
else" for what is true, and §2 gains the paragraph on the one call the component makes itself: where, how often,
|
||||
on which thread, what it never calls, what ends it, and that a call which never returned could not be stopped.
|
||||
- **Privacy Policy 2.17** at beta.43 (approved with that release's plan): 2.16 listed DLSS's and FSR's upscaling
|
||||
parameters by name, and Streamline's per-frame constants and the frame-generation configuration are in neither
|
||||
list, so they are named — and §4 says the two calls are intercepted only once a session with the option on has
|
||||
@@ -895,7 +910,7 @@ the catalog differ in either direction. **Reach** is where a value can be read f
|
||||
FrameLedger measures, from the arguments of a call the Overlay hooks, while the session records Advanced metrics —
|
||||
since 0.1.0-beta.40), `HookedCall` (an argument of a call the Overlay already hooks, not read yet), `NewHook` (a hook
|
||||
that is not built — Train B; no entry carries it since 0.1.0-beta.45), `BeforeAttach` (a call the game makes once,
|
||||
before FrameLedger is inside it, so no hook could read it — D129), `Spike` (Trains C and D), `Refused`, `Deferred`, `Identifier` (D104), `PlayerState`
|
||||
before FrameLedger is inside it, so no hook could read it — D129), `Spike` (Trains C and D; no entry since D154), `Refused`, `Deferred`, `Identifier` (D104), `PlayerState`
|
||||
(rule 4), `Licence`, `NotInHeaders`. ~~Only the first two are read by a build of Train A.~~ The first three are read
|
||||
(`AdvancedMetric.IsRead`).
|
||||
|
||||
@@ -1071,24 +1086,49 @@ before FrameLedger is inside it, so no hook could read it — D129), `Spike` (Tr
|
||||
| `sl.init.preferences` | The preferences the game started Streamline with | SessionFact | Streamline | BeforeAttach | Text |
|
||||
| `sl.constants.camera` | Camera position, axes and matrices | SessionFact | Streamline | PlayerState | Text |
|
||||
|
||||
**Inside the game: routes a spike decides**
|
||||
**Inside the game: what the graphics driver reports, asked for by the part inside the game itself** *(train C,
|
||||
owner decisions D132, D136, D138 — `17_HOOK_ENGINE` §Calls the Overlay makes into a driver; since 0.1.0-beta.47)*
|
||||
|
||||
Not an argument of a hooked call: the Overlay calls the driver's two read-only latency getters about once a second,
|
||||
only while a session records Advanced metrics, only for a Direct3D 12 game that had already loaded the driver's
|
||||
`nvapi64.dll`. The report becomes seven series — `adv.nvapi.reflex.frame_report.` and `simulation`,
|
||||
`render_submit`, `present`, `driver`, `os_queue`, `gpu_render`, `total` — each point the mean, in microseconds, of
|
||||
the frames one read summed; the sleep status becomes one table of the driver's five switches as seen over the
|
||||
session and, since 0.1.0-beta.48 (D144), every frame-generation multiplier it gave (it kept the last one, and a
|
||||
session that ended in a menu read 1). **Since 0.1.0-beta.48 (D142) two more series, an entry of their own** —
|
||||
`adv.nvapi.reflex.gpu_times.` and `active_render`, `frame_time` — the driver's `gpuActiveRenderTimeUs` and
|
||||
`gpuFrameTimeUs`, each the mean over the frames of that read that gave one. They are the driver's own figures, not
|
||||
spans between two of its marks: in Phantom Blade Zero `gpu_render` (the two GPU marks, idle time included) was
|
||||
longer than `total`, which is why its label now says what it includes (D143). **Reworded 2026-11-14 (D152)**:
|
||||
NVIDIA's header defines the active time as that span "excluding the idles in between", and in Cyberpunk 2077
|
||||
without frame generation the active time is the longer of the two on nine frames in ten (HANDOFF, item 47) — so
|
||||
the labels now say what each is (*the driver's own figure*; *between the driver's start and end marks*) and no
|
||||
longer that one is the other less its idle time. The numbers and the means are unchanged. An entry of their own keeps the
|
||||
seven spans within what one chart draws as lines. What the *game* asked of Reflex (`nvapi.reflex.mode`) is an argument of a function no module exports:
|
||||
reading it takes a patch at an address learned at run time, which is refused.
|
||||
|
||||
| Id | What it is | Scope | Source | Reach | Unit |
|
||||
|---|---|---|---|---|---|
|
||||
| `nvapi.reflex.mode` | Reflex: low-latency mode, boost, the frame-rate limit | SessionFact | Nvapi | Spike | Text |
|
||||
| `nvapi.reflex.sleep_status` | What the driver's low-latency state is | SessionFact | Nvapi | Spike | Text |
|
||||
| `nvapi.reflex.frame_report` | Latency per frame: simulation, render submit, present, driver, OS queue, GPU render | Series, one per device | Nvapi | Spike | Microseconds |
|
||||
| `sl.dlss.optimal_settings` | The render size and sharpness DLSS recommends | SessionFact | Streamline | Spike | Text |
|
||||
| `sl.dlss.vram_estimate` | DLSS's own estimate of its video memory | Series | Streamline | Spike | Mebibytes |
|
||||
| `sl.dlssg.options` | DLSS frame generation: mode, frames to generate | SessionFact | Streamline | Spike | Text |
|
||||
| `sl.dlssg.state` | DLSS frame generation: status, the most frames it can generate | SessionFact | Streamline | Spike | Text |
|
||||
| `sl.dlssg.frames_presented` | Frames DLSS frame generation presented, by its own count | Series | Streamline | Spike | Count |
|
||||
| `sl.dlssg.vram_estimate` | DLSS frame generation's estimate of its video memory | Series | Streamline | Spike | Mebibytes |
|
||||
| `sl.dlssd.options` | Ray reconstruction's options | SessionFact | Streamline | Spike | Text |
|
||||
| `sl.nis.options` | NVIDIA Image Scaling's options | SessionFact | Streamline | Spike | Text |
|
||||
| `sl.deepdvc.options` | RTX Dynamic Vibrance's options | SessionFact | Streamline | Spike | Text |
|
||||
| `sl.reflex.state` | Reflex through Streamline: availability and its frame reports | SessionFact | Streamline | Spike | Table |
|
||||
| `sl.pcl.markers` | PC-latency markers the game sets | Series | Streamline | Spike | Count |
|
||||
| `nvapi.reflex.mode` | Reflex: low-latency mode, boost, the frame-rate limit | SessionFact | Nvapi | RefusedRoute | Text |
|
||||
| `nvapi.reflex.sleep_status` | What the driver's low-latency state is | SessionFact | Nvapi | GameDriver | Table |
|
||||
| `nvapi.reflex.frame_report` | Latency per frame: simulation, render submit, present, driver, OS queue, GPU render | Series, one per device | Nvapi | GameDriver | Microseconds |
|
||||
| `nvapi.reflex.gpu_times` | The graphics card's time per frame, as the driver works it out: active render, frame to frame | Series, one per device | Nvapi | GameDriver | Microseconds |
|
||||
|
||||
**Inside the game: Streamline's feature functions — not read (D154, 2026-11-14)**
|
||||
|
||||
| Id | What it is | Scope | Source | Reach | Unit |
|
||||
|---|---|---|---|---|---|
|
||||
| `sl.dlss.optimal_settings` | The render size and sharpness DLSS recommends | SessionFact | Streamline | RefusedRoute | Text |
|
||||
| `sl.dlss.vram_estimate` | DLSS's own estimate of its video memory | Series | Streamline | RefusedRoute | Mebibytes |
|
||||
| `sl.dlssg.options` | DLSS frame generation: mode, frames to generate | SessionFact | Streamline | RefusedRoute | Text |
|
||||
| `sl.dlssg.state` | DLSS frame generation: status, the most frames it can generate | SessionFact | Streamline | RefusedRoute | Text |
|
||||
| `sl.dlssg.frames_presented` | Frames DLSS frame generation presented, by its own count | Series | Streamline | RefusedRoute | Count |
|
||||
| `sl.dlssg.vram_estimate` | DLSS frame generation's estimate of its video memory | Series | Streamline | RefusedRoute | Mebibytes |
|
||||
| `sl.dlssd.options` | Ray reconstruction's options | SessionFact | Streamline | RefusedRoute | Text |
|
||||
| `sl.nis.options` | NVIDIA Image Scaling's options | SessionFact | Streamline | RefusedRoute | Text |
|
||||
| `sl.deepdvc.options` | RTX Dynamic Vibrance's options | SessionFact | Streamline | RefusedRoute | Text |
|
||||
| `sl.reflex.state` | Reflex through Streamline: availability and its frame reports | SessionFact | Streamline | RefusedRoute | Table |
|
||||
| `sl.pcl.markers` | PC-latency markers the game sets | Series | Streamline | RefusedRoute | Count |
|
||||
|
||||
**Closed by a licence**
|
||||
|
||||
|
||||
@@ -1549,6 +1549,16 @@ probe never showed a deadlock.
|
||||
> real-game leg — a title that pulls Streamline or D3D12 in lazily, hooked through the wake — which the
|
||||
> `loader detour:` report line will show as a non-zero wake count with the family present from the first
|
||||
> bucket.
|
||||
>
|
||||
> **0.1.0-beta.46 (owner decision D134): one suspension for a batch, and the rule is as it was.** The rows a
|
||||
> watchdog tick finds are enabled under one `MH_ApplyQueued` — one stop of the threads where there was one a row
|
||||
> (`17_HOOK_ENGINE` §Unhooking, Batches). Still only on the watchdog, never from the detour and never on a game's
|
||||
> thread; the gate around the queue is not held across a symbol lookup, so it is never held with the loader's lock
|
||||
> wanted. What a stop of the threads costs in a real game was read from the owner's logs of 2026-11-13: 57 to
|
||||
> 215 ms, thirteen times over for a Streamline title until this release. **On beta.46, the same evening** (five
|
||||
> games, eighteen batches): 81–262 ms a batch for sixteen of them, and two that took 0.61 s and 1.26 s while their
|
||||
> game was loading — one stop where there were three and thirteen, and still a second of every thread of Hogwarts
|
||||
> Legacy standing still. Not explained (`17_HOOK_ENGINE` §Unhooking, Batches).
|
||||
|
||||
### H11 ◐ · XeFG and FSR3-FG identity — **AMD built 2026-09-04 through the ffx-api leaves, complete 2026-09-06; Intel closed by licence; FSR 3.0 host route built 2026-09-05**
|
||||
|
||||
@@ -1863,8 +1873,8 @@ Moved verbatim, in this order.
|
||||
| M12 ❓ | **Advanced metrics — which NVAPI rows answer on real hardware (D101, 2026-11-11).** `18_GPU_VENDOR_APIS` §The inventory lists sixty `nvapi.` rows whose reach is `Agent`. They are declared in the vendored headers; **none has been called on a GPU**, and CI has no driver, so it never takes that branch. Unknown per row: whether the RTX 5080 on the current driver answers or returns `NVAPI_NOT_SUPPORTED` (the memory-temperature target already does not exist on that card). | **The measurement is the bridge's probe on the owner's PC**, then the page itself (the release's owner-only item). Pre-committed: a call that does not answer → that row is N/A with NVAPI's own status as the reason, and nothing is put in its place; a call that hangs or faults twice → the row is off for the session (§Runtime policy); a value that contradicts the vendor's own tool → the row is withheld until it is explained. **Half answered the same day, by the bridge's own test on the dev box** (ctest `fl_nvapi_bridge`, AVAILABLE branch; RTX 5080): every fact answers (`present = 0xFFFFF`), eight of ten live groups answer (`0x33F` — no board and no power-supply temperature sensor on this card: N/A, by the first pre-committed outcome), the display answers its four groups, the global profile lists 24 settings; figures in `18_GPU_VENDOR_APIS` §L3. **Still open**: the same values on the page beside the vendor's own tool, and the session rows (`nvapi.session.*`), which need a game. **And one thing seen once and not explained**: in one test run of about a dozen that day, `FlNvReadLive` came back with no field at all although `FlNvReadFacts`, a moment earlier in the same process, had answered everything; nine further runs did not show it. A handle the driver invalidated is the usual cause of that shape, and nothing here re-enumerates after `FlNvInit`. Pre-committed for the reader that owns the thread: two readings in a row with no field → release and initialise the bridge again, once, and say so in the log; if that does not bring the fields back the layer is off for the session, as any layer that fails twice is. |
|
||||
| M13 ❓ | **Advanced metrics — LibreHardwareMonitor's CPU, memory, motherboard and storage groups, elevated, with PawnIO (D103, 2026-11-11).** Never opened by any build: §M10's elevated run has not been taken either, and this is a larger surface — a sensor chip on the LPC bus, the embedded controller, SPD over SMBus, SMART. Unknown: whether each group opens on the owner's board, what a refresh costs, whether opening the storage group touches removable drives (this PC once had a failing USB drive), and whether any group enables a privilege (`PrivilegeFootprintTests`). | **One elevated run with the probe verb, before the option exists.** Pre-committed: the storage group cannot be opened without touching removable drives → `lhm.storage.*` stays N/A in beta.39 and its reach reads `Deferred`; a node that throws twice → skipped for the session; the Agent above 1% of one core or 150 MB with the option on (NFR-2) → the slow groups are read less often or dropped before the release; a privilege enabled by a group → that group is not opened, and the owner is asked. **Two of the four answered 2026-11-11, before the option exists.** (1) **Storage: not opened, by the first outcome.** LibreHardwareMonitor 0.9.6's `StorageGroup` lists every drive through DiskInfoToolkit's `ReloadStorages` with no filter by bus and follows drives plugged in later — it cannot be opened without touching removable drives. `lhm.storage.*` reads `Deferred`, and `LhmGroups` has no member for it. (2) **Cost, unelevated, measured with `probe-advanced`** on the dev box: one refresh of the graphics-card group alone is 14 ms of processor time (62 ms elapsed) — 1.4% of one core at one a second, above NFR-2 — and one NVAPI read 0.4 ms. By the third outcome the sensor library is read every fifth tick (0.28%). **Still open, and the owner's**: the same probe as administrator with PawnIO — whether the processor, memory and motherboard groups open on this board, what they cost, and `PrivilegeFootprintTests`' new case on a token that holds the privileges (CI's does; the dev box's unelevated run passes by construction). **The first run was taken on 2026-11-12, by the owner, in ordinary use** (0.1.0-beta.40, the Agent as administrator with PawnIO, an i7-14700KF on a board with an IT8689E chip, an RTX 5080), and read here from a copy of the ledger and the Agent's log, not from a probe. **The groups open and read**: nine of ten sessions stored 119 processor series (a clock and a load per thread, temperatures, powers, voltages), 14 memory series and 21 motherboard series (six fans, six temperatures, nine voltages) beside the card's 41 — 195 from the sensor library in all. **No value was compared with another tool**; that is still the owner's. **Two faults, one cause** (`Infrastructure.Telemetry.LhmLibrary`): the Agent held up to three `Computer`s at once, and the library keeps the driver it reads the processor through and its bus mutexes per process — closing one `Computer` let go of them under the others. After seven sessions the Advanced reader's processor device threw `NullReferenceException` twice and was left alone (the page lost the processor until the reader reopened); once a session's start met another instance's close, the reader's `Open` threw `ObjectDisposedException`, and that session stored 17 series instead of 212. **Fixed 2026-11-12**: opens and closes are serialised and a `Computer` is parked, not closed, while another is in use. The cause is read from the log's timing and was not reproduced — it needs this elevation — so **whether the faults are gone is the owner's next sessions to show**: no `advanced: a device is left alone` and no `did not open` in the Agent's log. **First evidence, 2026-11-12, 0.1.0-beta.41, the same PC:** seven sessions between 06:38 and 07:01 with no `advanced:` line at all, each with the option on storing 212 or 213 series; on beta.40 that morning the processor device faulted out after each of six sessions (04:34–05:07) — thirteen of sixteen over the night. The reader failing to open was seen once in sixteen, so this is not yet enough to call that one gone. Still open: any value beside another tool. |
|
||||
| M16 ✅ | **The L2 telemetry layer's cost — the first number, and it is above NFR-2 (found 2026-11-11, measuring something else).** `LhmTelemetrySource` refreshes LibreHardwareMonitor's graphics-card group once a second in every recorded session. `probe-advanced` measured that refresh, through the same library and the same group, at **14 ms of processor time** on the dev box (RTX 5080, 41 mapped sensors, about twenty of them the Direct3D engine nodes the library enumerates per card) — 1.4% of one core, where NFR-2 allows the whole Agent 1% during capture and `14_TESTING` §Hook overhead's Agent figure has never been measured. This is a measurement of the call, not yet of a session: L2's own poller was not instrumented. | **Measure L2 in a session** (the Agent's processor time over a ten-minute capture, telemetry at 1000 ms and at 2000 ms). Pre-committed: at or under 1% → this row closes with the number; above → the owner chooses between a slower default for `telemetry.interval_ms`, reading the sensors the layer keeps from NVAPI on NVIDIA cards (L3 already has most, at 0.4 ms), or amending NFR-2 to what is measured. Not decided here, and nothing about L2 changes in the Advanced-metrics train. **Measured in a real Agent, 2026-11-11 (owner decision D110), and answered (D117).** `tools/agent-cost.ps1` runs the shipped `FrameLedger.Agent.exe --console capture` against a copy of hook-harness in a scratch data folder — a session that is not hooked, so the telemetry poller runs as in every session and nothing drains frames — and reads the Agent process's own processor time at exit; the cost per second is the slope between a 45 s and a 165 s session, two runs of each. Dev box (RTX 5080, not elevated, layers `l1+lhm+nvapi`): **19.3 ms of processor time per second of session = 1.93 % of one core with Advanced metrics off** (2,312 and 2,312 ms over 45 s; 4,594 and 4,656 ms over 165 s), **20.4 ms = 2.04 % with it on** (2,984 and 3,000; 5,547 and 5,344); peak working set 113 MiB and 119 MiB. A first pass with 30 s and 90 s sessions gave 1.56 % and 2.21 % — its two short runs differed by 670 ms, which is why the lengths were raised. So the probe's number holds in a session: the Agent's steady cost is about twice NFR-2's 1 %, nearly all of it the layer every session has always used, and the new option adds about a tenth of a percent. **The owner's answer: NFR-2 is amended to ≤ 2.5 % of one core** — the limit had never been measured, the sensors keep their one reading a second, and nothing in the code changes. Not measured: a hooked session (the drain's cost on top), a session with the Agent elevated and PawnIO's groups open, another PC. |
|
||||
| M14 ❓ | **Reflex latency per frame — is there a route within rules 4 and 5? (Train C, 2026-11-11.)** `17_HOOK_ENGINE` §Memory / latency names hooks on `NvAPI_D3D_SetSleepMode` / `SetLatencyMarker` and a call to `NvAPI_D3D_GetLatency`. NVAPI resolves all three through `nvapi_QueryInterface` by id — they are not exports, so a hook on them is a patch at an address learned at run time, the class refused on 2026-08-09. The route to try first needs no hook: the Overlay's own background thread **calls** `GetLatency` with the device of the swap chain it already hooks, once a second (the call returns the last 64 frames' reports). Unknown: whether calling into the driver from that thread is safe on every device kind, what it costs, what it returns when the game never enabled Reflex, and what it means for the Disclaimer's sentence about that thread. | **A spike on `hook-harness` and a stub first, then one real title.** Pre-committed: no route without a patch at a run-time address or a loader-lock call on the game's thread → Reflex stays N/A and the page says why; overhead above NFR-1 → the same. The owner says go or no on the spike's result. **2026-11-12 — the reading that comes before that spike is `spike-notes` §30** (owner decision D130: a document first, beside 0.1.0-beta.45; nothing was run). It finds: a hook on NVAPI's latency functions is the refused class, and a hook on Streamline's Reflex and PCL functions is train D's wrapper (§M15) — and would miss a game that fetched them before the attach, as `slInit` is missed (D129); the Overlay calling `slReflexGetState` itself breaks the thread contract the vendor's header states; **what remains is the route named in this row**, the Overlay calling two driver getters with the game's device, and a no-injection ETW route that gives the game-side markers only and makes the game post messages to its own window. Corrected there: `nvapi64.dll` exports **two** functions on the dev box (`nvapi_Direct_GetMethod` beside `nvapi_QueryInterface`), not one. The go or no is the owner's, and a go needs the owner's ruling that calling a driver getter with the game's device is inside rule 4. |
|
||||
| M15 ❓ | **The Streamline state behind `slGetFeatureFunction` — re-examined, not reopened (Train D, 2026-11-11).** The owner asked for the refusal in `handoff/history/p0-queue-1-6.md` to be looked at again. `18_GPU_VENDOR_APIS` §The trains states the route to try (hook the export, hand back a wrapper for a fixed list of names) and what it raises: the wrapper is a write to what the game receives, which rule 4 forbids as written; a wrapper must outlive the Overlay's unhook; a game that fetched its functions before the hook existed is never seen. | **A written design against each of the five grounds, then a spike.** Pre-committed: any ground unanswered → the route stays refused, and `sl.dlssg.*`, `sl.reflex.*` and the rest of that block read N/A with "refused" as the reason. Proceeding needs the owner's amendment of rule 4, asked with the rule quoted. |
|
||||
| M14 ❓ | **Reflex latency per frame — is there a route within rules 4 and 5? (Train C, 2026-11-11.)** `17_HOOK_ENGINE` §Memory / latency names hooks on `NvAPI_D3D_SetSleepMode` / `SetLatencyMarker` and a call to `NvAPI_D3D_GetLatency`. NVAPI resolves all three through `nvapi_QueryInterface` by id — they are not exports, so a hook on them is a patch at an address learned at run time, the class refused on 2026-08-09. The route to try first needs no hook: the Overlay's own background thread **calls** `GetLatency` with the device of the swap chain it already hooks, once a second (the call returns the last 64 frames' reports). Unknown: whether calling into the driver from that thread is safe on every device kind, what it costs, what it returns when the game never enabled Reflex, and what it means for the Disclaimer's sentence about that thread. | **A spike on `hook-harness` and a stub first, then one real title.** Pre-committed: no route without a patch at a run-time address or a loader-lock call on the game's thread → Reflex stays N/A and the page says why; overhead above NFR-1 → the same. The owner says go or no on the spike's result. **2026-11-12 — the reading that comes before that spike is `spike-notes` §30** (owner decision D130: a document first, beside 0.1.0-beta.45; nothing was run). It finds: a hook on NVAPI's latency functions is the refused class, and a hook on Streamline's Reflex and PCL functions is train D's wrapper (§M15) — and would miss a game that fetched them before the attach, as `slInit` is missed (D129); the Overlay calling `slReflexGetState` itself breaks the thread contract the vendor's header states; **what remains is the route named in this row**, the Overlay calling two driver getters with the game's device, and a no-injection ETW route that gives the game-side markers only and makes the game post messages to its own window. Corrected there: `nvapi64.dll` exports **two** functions on the dev box (`nvapi_Direct_GetMethod` beside `nvapi_QueryInterface`), not one. The go or no is the owner's, and a go needs the owner's ruling that calling a driver getter with the game's device is inside rule 4. **2026-11-13 — the owner answered (D132, D133).** Route D goes to the spike this row names, on `hook-harness` and a stub `nvapi64.dll`, with the ruling: a driver's read-only getter called with the device of the swap chain the Overlay hooks is inside rule 4 (`CLAUDE.md`, the rule's note of that day). No real game before the owner has seen the result, and nothing shipped changes for the spike (`spike-notes` §31, written after 0.1.0-beta.46). Route C is **refused**; the ETW route **stays closed**, and §G is not reopened. **2026-11-13 — the harness spike is done (`spike-notes` §31), and none of its stop conditions fired.** With a stand-in module: nothing is called or loaded when `nvapi64.dll` is absent, a missing getter is refused whole, an error and a report of nothing read as what they are, and a call the driver holds for seconds stops only the thread that made it — so not the watchdog. With the installed driver (32.0.16.2114, RTX 5080), in the probe's own process and with the probe setting the markers a game would: no fault before `NvAPI_Initialize`, without markers, or across 38 million reads beside a marker-setting thread; a call costs half a microsecond to a microsecond and a half; the report is readable from markers alone, in microseconds; and the Direct3D 12 **device** — the object the Overlay already holds — is what the driver takes. What only a game can say is unanswered: a game's own device, a real report, another driver. **The owner's next word is go or no for one real title**; a go is a plan of its own first. **2026-11-13, the same evening — go (D136)**: a plan for one title, Cyberpunk 2077; no code before the plan is approved, and no release carrying it before a stop while a game runs has been exercised on 0.1.0-beta.46 (owner-only item 44 (d)). **2026-11-13, the plan and four more answers (D138–D141).** The read has **no switch of its own**: it is part of Advanced metrics, so after the release it reaches every Direct3D 12 game that loaded the driver's `nvapi64.dll`, for everyone who switched Advanced metrics on — "one title" is the order of the owner's first runs, not a limit in code (D138). The probe ran a leg with a sleep mode first (D139; `spike-notes` §31, *The leg with a sleep*): **the getters do not wait behind `NvAPI_D3D_Sleep`** — thirty-one million reads beside a thread that slept 97 % of the time, none of a millisecond; a read after a sleeping frame costs about 2.6 µs. An `nvapi64.dll` loaded from the game's own folder is refused with the reason (D140). One call of 2 ms or more switches the read off until the game exits (D141). The plan's design, as reviewed against the source, is in [`handoff/history/0.1.0-beta.46.md`](handoff/history/0.1.0-beta.46.md) §The train after 0.1.0-beta.46. **2026-11-13, night — written; released as 0.1.0Line truncated
|
||||
| M15 🅓 | **Decided 2026-11-14 (D154): not built. The owner closed Advanced metrics with the refusal standing; the ten entries are listed as not read, with the reason.** ~~**The Streamline state behind `slGetFeatureFunction` — re-examined, not reopened (Train D, 2026-11-11).**~~ The owner asked for the refusal in `handoff/history/p0-queue-1-6.md` to be looked at again. `18_GPU_VENDOR_APIS` §The trains states the route to try (hook the export, hand back a wrapper for a fixed list of names) and what it raises: the wrapper is a write to what the game receives, which rule 4 forbids as written; a wrapper must outlive the Overlay's unhook; a game that fetched its functions before the hook existed is never seen. | **A written design against each of the five grounds, then a spike.** Pre-committed: any ground unanswered → the route stays refused, and `sl.dlssg.*`, `sl.reflex.*` and the rest of that block read N/A with "refused" as the reason. Proceeding needs the owner's amendment of rule 4, asked with the rule quoted. |
|
||||
| M10 ✅ | ~~PDH `\GPU Engine(*)\Utilization Percentage` summed across engines does not reproduce the Task Manager figure the doc invokes. Decide what we actually report and label it accordingly~~ **Decided 2026-09-09 (PR-E1): L1 does not read the engine counters at all.** `LoadPct` is L2's vendor-reported `GPU Core` load (measured ✓ on NVIDIA, §M5 row R1) and is labelled *GPU load (vendor)* wherever it is shown; on a machine without L2 the field is N/A, never a sum that is not the number the user expects. What L1 does read from PDH is one counter, `\GPU Adapter Memory(luid_…_phys_0)\Dedicated Usage`, bound by LUID — the figure Task Manager labels "Dedicated GPU memory", measured 1301 MB at an idle desktop on the RTX 5080. Reopening this needs a measurement of `max(engine)` against Task Manager's own number, not a decision |
|
||||
|
||||
#### §M5 — the decision table, pre-committed 2026-09-03 BEFORE the first run
|
||||
|
||||
@@ -0,0 +1,156 @@
|
||||
# 21 — Input devices: controllers, and keyboard-and-mouse activity
|
||||
|
||||
What FrameLedger reads about game controllers and about the keyboard and mouse, from where, and what it never reads.
|
||||
The numbers a session makes of it are in [`03_METRICS.md`](03_METRICS.md) §Input; the columns are in
|
||||
[`06_DATA_MODEL.md`](06_DATA_MODEL.md).
|
||||
|
||||
> **Status, 2026-11-14 — the reader exists and the Agent does not start it yet.** The model and the arithmetic
|
||||
> (`FrameLedger.Domain.Input`, `FrameLedger.Application.Input`, `Application.Recording.InputSessionBuilder`), the
|
||||
> storage (schema 0024, the `.partial` file's chunk 11, the finalizer for both tiers — `06_DATA_MODEL`) and the reader
|
||||
> itself (`Application.Input.InputReader`, `Infrastructure.Input`) are written and under test. Nothing composes the
|
||||
> reader into the Agent: the switch, the terms and the screens come in the pull requests after this one, and this
|
||||
> note is rewritten by each. **No report from a real controller has passed through any of this code**
|
||||
> (owner decision D157): the developer has no controller, and what happens on a real one is owner-only item 48.
|
||||
|
||||
## The owner's request and decisions (2026-11-14)
|
||||
|
||||
The request: whether a game supports controllers, on the game's page; the share of a session played with a controller
|
||||
and with the keyboard; how often a controller connected and disconnected in a session; the battery state that lasted
|
||||
longest; switches between makers' controllers and each maker's share; stored, and drawn; Xbox controllers and the
|
||||
DualSense first.
|
||||
|
||||
| | Decision |
|
||||
|---|---|
|
||||
| **D155** | Controllers are read **by the Agent, from outside the game**. No hook is added to a game and CLAUDE.md rule 4 is untouched. A session that is not hooked has the numbers as a hooked one does. |
|
||||
| **D156** | The reading is **on unless switched off** (Settings ▸ Controllers and input, `capture.input_devices`), and **reads nothing until the Privacy Policy that describes it — 2.22 or later — has been accepted on the PC**. An Agent that the logon task started after an update records sessions without it until the App has been opened once. |
|
||||
| **D157** | **Built without a probe.** Asked whether to run a probe tool with real controllers first, the owner chose to build straight. So every source says what it did (§What the reader says about itself), and each pull request and `LIMITATIONS.md` say what was verified against hand-made data only. |
|
||||
| **D158** | Keyboard and mouse are **one class, known only by the time of the last input** (`GetLastInputInfo`). No Raw Input registration for a keyboard or a mouse, no hook: no key ever enters FrameLedger's process. |
|
||||
| **D159** | **Nothing is ever sent to a controller**: no output report, no feature-report request, no `XInputSetState`. A DualSense on Bluetooth therefore has a battery level only when Steam or the game has already switched it to its long report (§DualSense). |
|
||||
| **D160** | The numbers are **in the CSV/JSON export and in a bug bundle** — they are columns of `sessions`, as the display mode's are — and the Privacy Policy's §3A says so. |
|
||||
| **D161** | **A session that is not hooked is: duration, hardware telemetry, the reason — and what the Agent reads from outside the game** (the game's memory since beta.12, controllers now). Every field measured inside the game still reads N/A. CLAUDE.md's sentence is amended with the pull request that makes it true. |
|
||||
| **D162** | Also built: the number of switches between a controller and the keyboard and mouse, and the share of time with no input; marks on the frame-time chart where a controller connected, dropped or ran low; a battery's first and last level and its rate; the kind of connection; a note where Steam Input presented the controller as an Xbox pad; a trend metric, a row in Compare, and "usually played with" on the game's page. |
|
||||
| **D163** | "Supports controllers" is **three pieces of evidence, never a verdict**: what Steam's own file on the disk says (no network: rule 8), which input libraries the game loaded, and how the game was actually played. From outside a game one can know that a controller was in use while the game was in front — not what the game did with it. |
|
||||
|
||||
## What is read, and from where
|
||||
|
||||
Everything is a Windows API in a library Windows ships. **No third-party library is added.**
|
||||
|
||||
| Source | What it gives | Why this one |
|
||||
|---|---|---|
|
||||
| Raw Input (`RegisterRawInputDevices`, usage page 1, usages 4 and 5, `RIDEV_INPUTSINK \| RIDEV_DEVNOTIFY`; `GetRawInputBuffer`, `GetRawInputData`, `GetRawInputDeviceInfo`, `GetRawInputDeviceList`) | the reports game controllers send, while the Agent is in the background; a controller arriving and leaving; its vendor and product ids | the documented way to receive a HID controller's reports without being in front, and it opens no handle to the device |
|
||||
| XInput 1.4 (`XInputGetState`, `XInputGetCapabilities`, `XInputGetBatteryInformation`) | each of its four pads: its state, wired or wireless, a battery in four levels | what an Xbox pad's battery is reported through |
|
||||
| `GetLastInputInfo` | the time of the last keyboard or mouse input in the user's session | a time and nothing else (D158) |
|
||||
| `GetForegroundWindow`, `GetWindowThreadProcessId` | whose window is in front | already used for the focus sample (`04_CAPTURE`) |
|
||||
| Steam's `appcache\appinfo.vdf`, on the disk | whether the store lists controller support for a library game | a local file: no request is made (rule 8) |
|
||||
|
||||
**Rejected, with the reason** (the checklist of `18_GPU_VENDOR_APIS` §Checklist applies to any library):
|
||||
|
||||
- **Windows.Gaming.Input** — its readings stop when the program is not in front, which the Agent never is.
|
||||
- **GameInput** — on a PC it is a NuGet package under Microsoft's licence terms with a redistributable to install.
|
||||
- **Opening the HID device** (`CreateFile`) — a handle of FrameLedger's on a controller can make a game's, or a
|
||||
remapper's, exclusive open of it fail. Raw Input needs none.
|
||||
- **A sixth native library** — parsing bytes a device controls in C++, inside an Agent that may run as administrator.
|
||||
The reader is C#, and what parses a report is `FrameLedger.Domain.Input`, with no pointer in it.
|
||||
- **Windows' own HID parser** (`hid.dll`'s `HidP_*`), to read *any* controller generically. It would have let a
|
||||
controller of a maker this build does not know count as *in use* — and nothing here could be tried on one. A
|
||||
controller whose layout this build does not know is listed, with its connections and drops, and is never *in
|
||||
use*: a guess would be a made-up number (§The reader).
|
||||
|
||||
## What is never read
|
||||
|
||||
Which button, where a stick or a trigger is, the motion sensors, the touchpad; which key, what was typed, where the
|
||||
mouse is; a controller's serial number, its Bluetooth address, its device path. A report is looked at to answer one
|
||||
question — *is anything on this pad in use?* — and, for a DualSense, to take its battery byte; the answer is kept and
|
||||
the report is not. `InputSessionBuilderTests` hold the stored JSON to a list of keys, so a key that could carry an
|
||||
identifier has to be added to a test first.
|
||||
|
||||
## Who a controller is
|
||||
|
||||
By its USB vendor and product ids only (`Domain.Input.ControllerCatalog`): Microsoft is the Xbox family, Sony
|
||||
PlayStation, Nintendo Nintendo, anything else *other* — except that a pad Windows presents through XInput is in the
|
||||
Xbox family whoever made it, because that is all Windows says of it. A model has a name only where the catalog lists
|
||||
its ids; a wrong name would be worse than none. Two pads of one model on one kind of connection cannot be told apart
|
||||
across a reconnect, and are not.
|
||||
|
||||
## XInput
|
||||
|
||||
A state is a pad *in use* when a button is down, a trigger is past `XINPUT_GAMEPAD_TRIGGER_THRESHOLD` or a stick is
|
||||
outside its `XINPUT_GAMEPAD_*_THUMB_DEADZONE` (`Domain.Input.XInputPad`) — a stick held counts, one that drifts inside
|
||||
the dead zone does not. Its battery is XInput's words: a wired pad, or four levels with no word for charging.
|
||||
|
||||
Two things about XInput are not established and are what item 48 is for: Microsoft's page for `XInputEnable` says
|
||||
that on Windows 10 and later "game controller input is automatically enabled/disabled by the system based on the
|
||||
application window focus", which may mean a program in the background reads a neutral state; and a pad on Bluetooth
|
||||
is reported not to answer `XInputGetBatteryInformation`. XInput also has no documented way to say which device one of
|
||||
its four pads is.
|
||||
|
||||
## DualSense
|
||||
|
||||
Sony's 054C:0CE6, and the Edge, 054C:0DF2 (`Domain.Input.DualSenseReport`). Three reports:
|
||||
|
||||
| Connection | Report | What it carries |
|
||||
|---|---|---|
|
||||
| USB | `0x01`, 64 bytes | sticks, triggers, buttons — and the battery: a level in tenths and what the battery is doing |
|
||||
| Bluetooth, as connected | `0x01`, 10 bytes | sticks, buttons, triggers. **No battery** |
|
||||
| Bluetooth, once switched | `0x31`, 78 bytes | the USB report's body, one byte later |
|
||||
|
||||
The pad sends the short report until some program asks it for a feature report or sends it an output report; from then
|
||||
until it reconnects it sends the long one. **FrameLedger never asks** (D159): a game that reads the short report through
|
||||
DirectInput would lose its input. So over Bluetooth the level is there when Steam or the game switched the pad, and is
|
||||
not otherwise. Windows hands every report of a device over at the length of the device's longest, so the short report
|
||||
arrives padded to 78 bytes with the id the USB report has: the connection, not the length, says which layout a report
|
||||
`0x01` has.
|
||||
|
||||
The layout was written from the open descriptions of the protocol. No code was taken from the Linux kernel's driver,
|
||||
which is under a licence this project cannot take code from.
|
||||
|
||||
## The reader
|
||||
|
||||
`Application.Input.InputReader` over `Infrastructure.Input.Win32InputBackend`, on the thread of
|
||||
`Infrastructure.Input.InputDeviceHub` — named `fl-input`, and **there only while a session has a view of the hub**:
|
||||
with no session there is no thread, no window and no registration.
|
||||
|
||||
**A slice, about ten times a second.** The reader takes what Windows has: the controllers that came and went, the
|
||||
reports that arrived (in bulk — `GetRawInputBuffer` — not one message at a time: a DualSense sends some hundreds a
|
||||
second, and the Agent's whole budget is 2.5 % of one core, NFR-2), the state of XInput's connected pads, the time of
|
||||
the last keyboard or mouse input, and the process whose window is in front. From that it makes one `InputSlice`,
|
||||
the same for every session that is running; each session's view counts it when a window of *its* game was in front
|
||||
(`Application.Input.InputTickAccumulator`), and the telemetry poller takes the sum once a second.
|
||||
|
||||
**The window.** Raw input is delivered to a window. The reader's is a child of `HWND_MESSAGE`: never shown, in no
|
||||
task bar, receiving no broadcast, answered by Windows' default procedure. It is registered for HID usage page 1,
|
||||
usages 4 (joystick) and 5 (gamepad) — `InputReader.RegisteredUsages` — and for nothing else.
|
||||
|
||||
**What a controller is.** Each of XInput's pads that is connected is one; each controller Windows does *not* present
|
||||
through XInput is one. A device Windows presents through XInput is also seen by raw input and is **not** a second
|
||||
controller: it gives the pads their name where that cannot be mistaken — every XInput-class device a player could
|
||||
hold has the same two ids — and is otherwise only the witness of the next paragraph. An empty XInput slot is asked
|
||||
about once in twenty slices (XInput looks for a device each time) and at once when a controller arrives or leaves;
|
||||
a connected pad's battery once in fifty.
|
||||
|
||||
**Where XInput says nothing.** If XInput returns a pad at rest for ever because the Agent's window is never in front
|
||||
(§XInput), the device's own reports are the evidence: a slice in which an XInput-class device's reports *changed*
|
||||
while no pad's packet number moved — in that slice or the one before — is counted (`XInputSilent`). After ten of
|
||||
them, **and only if XInput has never once been seen to move**, such a slice counts the lowest connected pad as in
|
||||
use. That is coarser than XInput's dead zones — a stick that drifts counts — and is used only where the better
|
||||
source is silent; a session's stored counts say which it was.
|
||||
|
||||
**Which controllers are read for use.** XInput's pads, and a DualSense by its own reports. Any other controller —
|
||||
a DualShock 4, a Switch Pro controller — is listed with its connections and drops and is never *in use*.
|
||||
|
||||
**Faults.** A slice that throws is counted and skipped; twenty in a row end the run with one line in the Agent's
|
||||
log, and the sessions go on without readings. When a run ends, one line says what it did: slices, whether Windows
|
||||
accepted the registration, reports received and not read, XInput's reads and silent slices, whether the time of the
|
||||
last input could be read, the thread's processor time, faults. Nothing in it names a device.
|
||||
|
||||
**Held by a gate.** `tools/input-readonly-check.ps1` (`12_BUILD` step 14g): the reader's calls are a committed list,
|
||||
none of which sends to a device, injects input or reads a key; no other managed source and no native source names
|
||||
an input function.
|
||||
|
||||
## What the reader says about itself
|
||||
|
||||
`Application.Input.InputHealth`, carried by every reading and stored with the session: whether Windows accepted the
|
||||
registration, how many reports came and how many could not be read, whether XInput's library was there and how many
|
||||
states it returned, how often a controller's own reports said *in use* while XInput said nothing, whether the time of
|
||||
the last input could be read, how many slices were taken and how much processor time the reader's thread used. Counts
|
||||
and yes-or-no answers; nothing in it names a device.
|
||||
+487
-68
@@ -84,6 +84,10 @@ owner-only items stay below; the history of every train, the passed owner-only i
|
||||
| `§beta.42`, what the owner's seven sessions on beta.42 showed (D121 answered, the guard's lost launches), beta.43's design as planned | [`handoff/history/0.1.0-beta.42.md`](handoff/history/0.1.0-beta.42.md) |
|
||||
| `§beta.43`, what the owner's nine sessions on beta.43 showed, session by session (item 41), the traps of that train | [`handoff/history/0.1.0-beta.43.md`](handoff/history/0.1.0-beta.43.md) |
|
||||
| `§beta.44`, what the owner's eight sessions on beta.44 showed, session by session (item 42), this release's facts, the traps of that train | [`handoff/history/0.1.0-beta.44.md`](handoff/history/0.1.0-beta.44.md) |
|
||||
| `§beta.45`, what the owner's seven sessions on beta.45 showed, session by session (item 43), that release's facts and SonarCloud's gate on its commit, the traps of that train | [`handoff/history/0.1.0-beta.45.md`](handoff/history/0.1.0-beta.45.md) |
|
||||
| `§beta.46`, what the owner's five sessions on beta.46 showed (item 44), the design of the train that followed as the plan's review left it (`§The train after 0.1.0-beta.46`), that release's facts, the traps of that train | [`handoff/history/0.1.0-beta.46.md`](handoff/history/0.1.0-beta.46.md) |
|
||||
| `§beta.47`, what that release decided beyond D136–D141, what item 44's last part showed, that release's facts, the traps of that train, its NEXT as the owner's sessions of 2026-11-14 changed it | [`handoff/history/0.1.0-beta.47.md`](handoff/history/0.1.0-beta.47.md) |
|
||||
| `§beta.48`, what that release decided beyond D142–D147, that release's facts, the traps of that train, its NEXT and its "Left open" as item 46 changed them | [`handoff/history/0.1.0-beta.48.md`](handoff/history/0.1.0-beta.48.md) |
|
||||
| `§Owner-only`, an open item | [§Owner-only](#owner-only--no-pr-can-close-these) below |
|
||||
| `§Owner-only`, a passed item (3, 12, 14–19, 38, 39) | [`handoff/owner-only-passed.md`](handoff/owner-only-passed.md) |
|
||||
| `§Traps`, `§Two corrections carried forward` | [`handoff/traps.md`](handoff/traps.md) |
|
||||
@@ -91,82 +95,115 @@ owner-only items stay below; the history of every train, the passed owner-only i
|
||||
|
||||
---
|
||||
|
||||
## **START HERE** — 2026-11-12, 0.1.0-beta.45: six more of Streamline's calls, hooked only where asked; `slInit` stays out; the Reflex spike as a document
|
||||
## **START HERE** — 2026-11-14, 0.1.0-beta.49: item 46 read; the frames counted for the log, Reflex and frame generation together; a read a second on a grid; the Agent keeps the reading that waits
|
||||
|
||||
*Status is `docs/changelog/0.1.0-beta.45.md`; this is what no other file carries.* The owner ran eight sessions on
|
||||
beta.44 the evening it was released and said: add the three new ones, update, go on. They were read from a copy of
|
||||
the ledger and the logs (#426); asked to reopen D112, the owner was shown why `slInit` cannot be seen and chose to
|
||||
leave it out (D129), chose six other calls for one release (D130), and approved the plan with Privacy Policy 2.19's
|
||||
wording. Four pull requests and this one: #427 (`slIsFeatureSupported`, `slIsFeatureLoaded`, `slSetFeatureLoaded`
|
||||
in the Overlay; D129–D131), #428 (`slAllocateResources`, `slFreeResources`, `slShutdown`), #429 (the Agent, the
|
||||
App, Privacy Policy 2.19), #430 (train C's spike, a document: `spike-notes` §30). **What the eight sessions on
|
||||
beta.44 showed, session by session, is [`handoff/history/0.1.0-beta.44.md`](handoff/history/0.1.0-beta.44.md)**;
|
||||
what each pull request built is [`17_HOOK_ENGINE.md`](17_HOOK_ENGINE.md) §Hook inventory (the two rows of the six
|
||||
calls, with their measured cost) and [`18_GPU_VENDOR_APIS.md`](18_GPU_VENDOR_APIS.md) §Train B (the fourth step).
|
||||
*Status is `docs/changelog/0.1.0-beta.49.md`; this is what no other file carries.* The owner ran item 46 on
|
||||
beta.48 the afternoon it was released — ten sessions, then eight more — and said: check (#455, and item 46's last
|
||||
paragraphs, below). The read works, the samples are a second apart, both games give both of the driver's own
|
||||
times, the multipliers are listed, off means off, **and the owner's word: no hitch**. Two things were left, the
|
||||
owner said *do both*, and four answers given while planning made the train (D148–D151): #456 (the Overlay counts
|
||||
each summed frame for its log), #457 (the watchdog's periodic tick on a grid), #458 (the Agent keeps the reading
|
||||
that waits; the guide on whose switches the table shows), and this release. **beta.48's own section, its traps
|
||||
and its release facts are [`handoff/history/0.1.0-beta.48.md`](handoff/history/0.1.0-beta.48.md).**
|
||||
|
||||
### What this release decided, beyond D129–D131
|
||||
### What this release decided, beyond D148–D151
|
||||
|
||||
- **Everything the six calls give is word 1 of a feature's slot, and one reserved word.** Bits 2–4 the two answers
|
||||
(supported, with the `sl::Result` in bits 8..15; loaded and its value), bits 5–6 the game switching the feature
|
||||
off and on, bits 16..19 and 20..23 two counts that stop at fifteen and never carry; `slShutdowns` took the first
|
||||
of three reserved words (@308). Layout 5 and schema 23 as they were. **The answers are the process's and a new
|
||||
request keeps them; the switching, the counts and the shutdowns are a session's and a new request clears them.**
|
||||
- **A refusal is the answer.** `slIsFeatureSupported`'s detour calls the original first and keeps whatever it
|
||||
returned; the page names it by NVIDIA's enumerator (forty codes, the same order at sixteen upstream tags from
|
||||
v2.0.0 to v2.14.16), `result <n>` past the list, 255 for a code a byte could not carry.
|
||||
- **The two calls on a game's way out note the call, then call the original, and run nothing after it** —
|
||||
`slFreeResources` and `slShutdown`. The fixture shuts Streamline down and goes on using the stub through every
|
||||
detour.
|
||||
- **The adapter is never read** (D131), and the build refuses the names of `sl::AdapterInfo`'s members in the code
|
||||
loaded into a game (`overlay-fields-check`); the fixture hands a wild LUID pointer.
|
||||
- **A stop restores its patches one after another, about 160 ms each.** MinHook stops every thread of the process
|
||||
for each `MH_DisableHook`. With six more patches the stop's last log lines were cut at the two seconds the
|
||||
Overlay waited for them; the wait is now sized to the patch table (`250 ms × kMaxPatches`). The patches were
|
||||
always restored; `UNHOOKED` is written after the last. **Not changed, and proposed**: queueing the restores (and
|
||||
the installs) so the threads are stopped once — a change to the hook engine's order of operations, which wants
|
||||
its own pull request, its own measurement and the owner's word. Until then a stop in a Streamline game with
|
||||
Advanced metrics on takes two to three seconds on the thread that stops.
|
||||
- **Six calls are one sentence on the page**, each by its function's name under which of three things became of
|
||||
it; a row stored before this release has none of the six and no such sentence.
|
||||
- **`AdvancedReach.BeforeAttach` is a reason of its own** for `sl.init.preferences`: not "a later release". No
|
||||
catalog entry carries `NewHook` any more; the value stays, for rows a later train may add.
|
||||
- **Where the rows sit in the table** (rows are patched in its order): the two questions after beta.44's two, at
|
||||
the head; `slSetFeatureLoaded` after `slSetConstants`; the three counted calls last of the Streamline block.
|
||||
- **Train C's spike is a reading** (`spike-notes` §30): hooking NVAPI's or Streamline's latency functions is
|
||||
refused or is train D's wrapper; the Overlay calling `slReflexGetState` breaks the vendor's thread contract;
|
||||
what remains is the Overlay calling two driver getters with the game's device, and a no-injection ETW route
|
||||
that gives half the number. It ends in three questions that are the owner's.
|
||||
- **The counts are of each frame's own two numbers, with sums, and no threshold.** The draft counted spans of no
|
||||
length; a sample whose mean span is half a microsecond says spans of one or two microseconds exist, and a count
|
||||
of exact zeros would have read "the driver's" where it was "ours". So the frames that have both a span and an
|
||||
active time are kept in two heaps — active longer than the span, or not — each with its count and both sums.
|
||||
- **A batch's state is three things**: the driver's low-latency switch, its "the game sleeps" switch
|
||||
(`bUseGameSleep`: NVAPI's "is `NvAPI_D3D_Sleep()` being called") and its frame-generation multiplier. The second
|
||||
was added on the owner's word — Reflex goes with frame generation in the owner's games, and the low-latency
|
||||
switch can be the NVIDIA App's override — and Clair Obscur's two sessions read exactly that: `bUseGameSleep`
|
||||
off throughout without frame generation, on with ×3.
|
||||
- **Only the driver read and the publication are the periodic tick's.** The request is still followed on every
|
||||
tick, so the hooks a session asks for go in on the tick the loader woke — a game that has just loaded
|
||||
Streamline calls it at once. A draft that moved the whole block would have missed those calls.
|
||||
- **One read is armed at every periodic tick, and the grid is what keeps two apart**: half a second at the least,
|
||||
after a tick that ran that late. "At most once a second" is no longer said anywhere.
|
||||
- **A session's first publication may hold a moment's worth.** A request seen on a woken tick is published by the
|
||||
periodic tick that follows, however soon. One test read a single publication as complete and had to stop.
|
||||
- **The Agent keeps two sets, and an empty one does not wait.** A reading can stand at the sample after the one it
|
||||
would have ridden — a second later. With the sensor interval above a second the oldest is still pushed out.
|
||||
- **No legal text changed (D149)**, although a bug report carries the Overlay's logs and so these lines: the
|
||||
owner was told and chose it. The Privacy Policy names the logs of the component loaded into games.
|
||||
- **The plan was reviewed against the source by a second reader before the owner saw it, and sixteen things in
|
||||
the draft were wrong** — among them the three above, and the whole of the Agent's half, which the draft did not
|
||||
have.
|
||||
|
||||
### Traps this train left
|
||||
|
||||
- **The catalog table of `18_GPU_VENDOR_APIS` is compared with the catalog row for row by a test**: a catalog
|
||||
entry and its row go in the same commit, or the Application tests are red.
|
||||
- **Qodana's native report again found an index into the feature slots computed as a 32-bit product** (#427, the
|
||||
harness's probe): write `size_t{2} * FL_ADV_FEATURE_WORDS`. It is advisory and auto-merge does not wait for it;
|
||||
both reports were read before each merge.
|
||||
- **A second `region` inside the probe's block is C4456**, and warnings are errors: name the inner one otherwise.
|
||||
- **A test method over sixty lines is MA0051** in the test projects too; split the assertions by what they cover.
|
||||
- **The injected test waits for the stop**: with eighteen patches a stop takes about three seconds, so its wait is
|
||||
200 iterations.
|
||||
- **The shell tool refuses `sleep N; command`**: wait in a background `until` loop.
|
||||
- **After a lower pull request is squashed**, `git diff <old tip> origin/main` empty proves the squash is the
|
||||
branch; then `git rebase --onto origin/main <old tip> <next branch>` and a forced push with lease.
|
||||
- **A cause I offered and then counted away**: "the holes are the sensor library's fifth tick" — 25 of 134 fell on
|
||||
one. The pattern that was there (46 of 134 exactly five samples apart) was the Agent's own attach rule, found
|
||||
by reading `SessionRecorder`, not by looking harder at the Overlay.
|
||||
- **A fixture that proved nothing**: the case for a woken watchdog first churned `sl.common.dll`, which wakes
|
||||
nobody — it is in neither the inventory nor the census — and passed. It was caught only because the case
|
||||
asserts, from the log, that the watchdog *was* woken (0 early ticks). **A test of a mechanism asserts that the
|
||||
mechanism ran.** `opengl32.dll` is the wake that unloads nothing under a hook.
|
||||
- **Qodana's native report reads the tests**: `static_cast<unsigned long long>(a * b)` is
|
||||
`bugprone-implicit-widening-of-multiplication-result`. Widen an operand, not the product.
|
||||
- **A here-document with an apostrophe in it failed again.** Edit scripts are files.
|
||||
- **No edit while a gate runs still holds when CI asks for one**: the Qodana fix went into a second worktree of
|
||||
the lower branch, and reached the upper one by a merge.
|
||||
- **The item's own text said "nothing is lost by it" of the holes**, on a reading of the Overlay alone. A reading
|
||||
was lost at every return to step. Say what was looked at.
|
||||
|
||||
### NEXT
|
||||
|
||||
1. **The owner runs item 43** — the first time any of the six new hooks is in a real game, and two of them are on
|
||||
the way out of one. Not first on a game under the user-mode exception's trial (D38).
|
||||
2. **The owner reads `spike-notes` §30 and answers its three questions.** No code of train C before that.
|
||||
3. **The stop's cost** (above): whether to batch the restores is the owner's to say.
|
||||
4. **Train D** after train C, the same way: a spike first.
|
||||
1. ~~**The owner runs item 47**~~ **Run and read 2026-11-14** (item 47, *Run 2026-11-14*): the difference in
|
||||
Cyberpunk 2077 is the driver's, the holes are gone from steady play, off means off, and the stop fired once.
|
||||
2. **The two GPU labels were reworded on the owner's word** (D152, 2026-11-14; strings in three languages, the
|
||||
guide — in `[Unreleased]`, not in a release yet). **D141's stop stays as it is, and nothing more of Reflex is read** (D153, the owner
|
||||
the same evening: "it only has to tell whether the game has it or not; Kingdom Come: Deliverance II has no
|
||||
Reflex in its settings" — so that session lost nothing to the stop). (f) and (g) are said: the App's *Low
|
||||
Latency Mode* is off, and no hitch.
|
||||
3. **`slAllocateResources`** keeps its patch (D135); looked at again when there are more sessions.
|
||||
4. ~~**Train D**~~ **Advanced metrics is closed (D154, 2026-11-14): train D is not built.** The owner was shown
|
||||
the catalog — 140 entries, 110 read — and what the ten entries of reach `Spike` hold (Streamline's own headers,
|
||||
2.14.16: DLSS frame generation's options and state, the video-memory estimates, ray reconstruction's, Image
|
||||
Scaling's and Dynamic Vibrance's options, the PCL markers), with what reading them takes: a function of ours
|
||||
handed to the game in place of Streamline's (rule 4), which a game that fetched its functions before the
|
||||
attach never calls. The owner: "Đóng luôn". The ten are `RefusedRoute` now, the guide no longer says a later
|
||||
release reads more, and §M15 is decided. **What is next is the controller feature**, planned in a session of
|
||||
its own.
|
||||
|
||||
### Left open by this session
|
||||
|
||||
- **This release's own facts** — the tag's run, the digests, the delta — are not in any file yet: the release is cut
|
||||
after this text. Record them in the next pull request, with what SonarCloud and Qodana said.
|
||||
- **No real game was run on this build.** Six new patch sites, tested with the harness and the stub; their cost
|
||||
measured on the headers.
|
||||
- **Off means off (item 42 (f)) has never been exercised on a real game**; it is item 43 (f) now, for all ten.
|
||||
- ~~**This release's own facts** — the tag's run, the digests, the delta — are not in any file yet: the release is cut
|
||||
after this text. Record them in the next pull request, with what SonarCloud and Qodana said.~~ **Recorded
|
||||
2026-11-14: 0.1.0-beta.49 was released 2026-11-14T11:12:44Z** (18:12 in the owner's time zone) from the signed
|
||||
tag on `afe4984` (#459), by run 43587336452 — green at the first attempt, one run for the one tag push. Eight
|
||||
assets; the seven digests of `SHA256SUMS.txt` equal the ones GitHub computed, and the portable package hashed
|
||||
here equals its line; the five native libraries in it carry `FL_BUILD_ID v0.1.0-beta.49`, none of them
|
||||
`-dirty`. The delta from beta.48 is 1 100 211 bytes beside a full package of 110 803 443 — "Delta processed
|
||||
0452 files. 0023 patched, 0429 unchanged". The wiki was published by run 43588972123. **Two rehearsals on the
|
||||
release branch**: run 43580081466 at `1ab2809`, and — after a test-only fix reached the branch — run
|
||||
43581734484 at `9f94356`, whose tree is the released one (a delta of 1 134 949 bytes, the same file counts).
|
||||
**SonarCloud analysed `afe4984`: the quality gate passed and no issue is open on `main`. Qodana's two reports,
|
||||
CodeQL and `check` are green on that commit.** On the way two advisory checks did find something, each in a
|
||||
test of this train and each fixed before its pull request merged: Qodana's native report on #456 (two
|
||||
products widened after the multiplication), SonarCloud on #457 (a line of the log handed to `printf`). **The
|
||||
train stopped once for the owner**: two signed merges timed out at the passphrase prompt after #457; it went on
|
||||
when the owner had unlocked the key. The tag's message reads `FrameLedger 0.1.0-beta.49` where the tags before
|
||||
it read the bare version — nothing reads it, and a pushed tag is not moved.
|
||||
- **Why Cyberpunk 2077's active render is longer than its span without frame generation** — item 47's to say. A
|
||||
third session that afternoon repeated it (233: 3.40 against 3.13 ms at 292 of 296 samples) and a session of
|
||||
menus did not (232: 0 of 126).
|
||||
- **The Agent's half of the holes is read from the code and fits the ledger; it is not measured.** And with both
|
||||
sides on a second a slip of phase can still leave a sample without a report: item 47 counts them.
|
||||
- **A game that exits by itself loses the batch of counts in hand** — under a minute. Not changed: nothing runs
|
||||
at a process's exit.
|
||||
- **Where the third of a second of a poll goes is not established** (the history file of beta.48 has what is
|
||||
known). Not looked at in this train.
|
||||
- **With the sensor interval above one second, some readings of the driver's report are not stored** — the oldest
|
||||
of the two that wait is pushed out. Said in the guide; not changed.
|
||||
- **No test runs the whole path through the real Agent**: the injected tests stop at the shared memory, the
|
||||
sampler's and the pending queue's start from it.
|
||||
- **Two install batches of beta.46 took 0.61 s and 1.26 s and nothing explains them.** Item 46's ten sessions had none
|
||||
above 191 ms.
|
||||
- **The Japanese strings are unreviewed**, as every `ja` string is; this release added none.
|
||||
- **(c) and (h) of item 43**, which only the owner sees, are still not exercised.
|
||||
- **Valor Mortis's crash at 51 s** (twice, beta.40 and beta.44) **and Black Myth: Wukong's fault in Steam's crash
|
||||
handler at every exit** are not explained. One session of each with hooking off is the comparison that is missing.
|
||||
- **What item 41 left unexercised**: a configure through the FidelityFX 2.3 loader (Cyberpunk 2077 with FSR frame
|
||||
@@ -174,13 +211,11 @@ calls, with their measured cost) and [`18_GPU_VENDOR_APIS.md`](18_GPU_VENDOR_API
|
||||
- **A fault while a game is closing is not seen by a hooked session** (D127: written down, not changed).
|
||||
- **`docs/LIST_GAME_TESTED.md` is as of 2026-11-06**: refreshing it is a new copy of the ledger and the owner's review.
|
||||
- **Item 40 (d)** was not exercised and the owner has not said item 40 passed. **Items 36 (d) and 37 are still open.**
|
||||
- **What an empty process snapshot does to the watcher's tick in a real session** was not looked into (seen once in
|
||||
a test on 2026-11-12).
|
||||
- **`LIMITATIONS.md` and the accuracy statement still say the processor's, the memory's and the motherboard's
|
||||
sensors "have never been read on real hardware"** — the owner's to reword. The alpha line still rests (D98).
|
||||
|
||||
**Owner-only:** item 43; the three questions of `spike-notes` §30; one session each of Valor Mortis and Black
|
||||
Myth: Wukong with hooking off; what item 41 left unexercised; item 40 (d).
|
||||
**Owner-only:** item 47; one session each of Valor Mortis and Black Myth: Wukong with hooking off; what item 41
|
||||
left unexercised; item 40 (d).
|
||||
|
||||
## Owner-only — no PR can close these
|
||||
|
||||
@@ -624,6 +659,358 @@ Myth: Wukong with hooking off; what item 41 left unexercised; item 40 (d).
|
||||
starting the game afresh runs it without any of the ten hooks, and if that cures it the hook is one of the
|
||||
six new ones or the four before — the overlay log's last `HOOK_INSTALLED` lines and Windows' fault entry say
|
||||
which is nearer. A game that will not start at all: *Disable all hooking* (Settings ▸ Capture).
|
||||
**Seven sessions were run on 2026-11-13 and read the same day** ([`handoff/history/0.1.0-beta.45.md`](handoff/history/0.1.0-beta.45.md) §What the owner's
|
||||
seven sessions on beta.45 showed): (a) happened — Privacy Policy 2.19 accepted once; (b) five Streamline games, six sessions —
|
||||
`slIsFeatureSupported` read in all, `slIsFeatureLoaded` in three games, `slSetFeatureLoaded` in two,
|
||||
`slFreeResources` and `slShutdown` once in one game each, **`slAllocateResources` in none**; (d) held on Kingdom
|
||||
Come: Deliverance II; (e) **nothing different**: Hogwarts Legacy and Black Myth: Wukong fault while closing in
|
||||
the same module at the same offset as before, the other four games leave no fault; (g) no `PATCH_FAILED`, no
|
||||
fault counted, rates as before — and no session was stopped while its game ran, so the part about
|
||||
`UNHOOK_RESTORED` lines was not exercised and was worded wrongly. **(f) was not exercised; (c) and (h) are the
|
||||
owner's to say.** Taken as passed on the owner's "check the logs and go on", 2026-11-13; (f) stays open.
|
||||
`slAllocateResources` keeps its patch (D135, the same day).
|
||||
44. **beta.46 — hooks in and out under one stop of the threads, in real games** (D134). **Not first on a game under
|
||||
the user-mode exception's trial** (D38): a crash there ends the exception for good. (a) **The update from
|
||||
beta.45**: Help ▸ Check for updates, *Restart to update* with no game running; **the terms window does not
|
||||
show** (nothing new is read). (b) **Any Streamline game with Advanced metrics on** (Hogwarts Legacy first — its
|
||||
thirteen patches took 2.8 s on beta.45 — then Phantom Blade Zero, Cyberpunk 2077, Dying Light: The Beast, Black
|
||||
Myth: Wukong): play as usual and close the game. Its `logs\overlay-<pid>-….log` has `PATCH_BATCH install`
|
||||
lines, and the `sl.interposer.dll` `HOOK_INSTALLED` lines above each carry **the same time** to the thousandth
|
||||
of a second, not times 0.06–0.2 s apart. Say the `a=` of each `PATCH_BATCH` line: it is the microseconds the
|
||||
game's threads were stopped for that batch. (c) **How the game's start feels**: no worse than on beta.45 — the
|
||||
hitching while a game with Streamline starts should, if anything, be shorter. (d) **A stop while the game
|
||||
runs**, which no session has exercised since beta.43: with a game running and being recorded, switch *Disable
|
||||
all hooking* on in Settings ▸ Capture; the part inside the game stops at its next safety scan, within 30
|
||||
seconds. The game must go on running without a freeze of seconds; the log then has `STOP`, an `UNHOOK_RESTORED`
|
||||
line for every patch, one `PATCH_BATCH restore` line and `STOP_FLUSHED … a=1`. Switch it back off afterwards. (e) **A game with no
|
||||
Streamline** (Kingdom Come: Deliverance II, Lies of P): its FSR rows are under `PATCH_BATCH` lines as well, and
|
||||
the session reads as before. (f) **Nothing else moved**: no crash, no `PATCH_FAILED`, no `UNHOOK_DECLINED`
|
||||
unless another overlay is running, the same hooks in `HOOK_INSTALLED` as on beta.45 for the same game, frame
|
||||
rates and the frame-generation factor as before, the Advanced rows as before. (g) **Off means off** (item 43
|
||||
(f), never run): with Advanced metrics off, start a game afresh; no `HOOK_INSTALLED` line names any of the ten
|
||||
Advanced-only calls.
|
||||
**What each outcome means, written before the run.** A `PATCH_BATCH install` whose `a=` is about what one
|
||||
patch cost on beta.45 (60 000–220 000) is the expected answer: one stop of the threads. An `a=` of a second or
|
||||
more: one stop is long in that game — say which game and the number; it is still one where there were thirteen,
|
||||
but it is what would decide whether batches need a ceiling. `HOOK_INSTALLED` lines of one batch with different
|
||||
times: the batch fell back to one patch at a time — the log then also has a `PATCH_FAILED` — say so with the
|
||||
log. A game that hitches at its start as it did not on beta.45, or freezes at (d): say so at once, with the
|
||||
game; 0.1.0-beta.45 is the build without this change. A hook that was in on beta.45 and is not on beta.46
|
||||
(compare the `HOOK_INSTALLED` lines), or a session that reads *not hooked* where it read *read*: the batch lost
|
||||
a patch — the log's `PATCH_FAILED` line names it and why. A crash in play or at exit that is new: say so at
|
||||
once; *Disable all hooking* runs the game with nothing patched after the start.
|
||||
**Five sessions were run on 2026-11-13 and read the same day** ([`handoff/history/0.1.0-beta.46.md`](handoff/history/0.1.0-beta.46.md)
|
||||
§What the owner's five sessions on beta.46 showed): (a) held — the terms window did not show; (b) five Streamline games — every batch's lines carry one
|
||||
time; `a=` is 81 417–261 920 for sixteen of the eighteen batches, **1 260 835 for Hogwarts Legacy's thirteen
|
||||
and 608 700 for three of Cyberpunk 2077's**, neither explained — and the sentence above about a fallback is
|
||||
wrong: a batch finished one patch at a time leaves no line unless a patch fails for good, so the log cannot say
|
||||
which of the two a long `a=` was; (f) held — no crash in play, no `PATCH_FAILED`, no `UNHOOK_DECLINED`, the
|
||||
same hooks as on beta.45, rates and factor as before, the two known faults on the way out at their old offsets.
|
||||
**(d), (e) and (g) were not exercised; (c) is the owner's to say.** Not passed: (d) is the half of this release
|
||||
that no real game has run.
|
||||
**2026-11-14, three more sessions (203–205), read the same morning — (d) is still not exercised.** *Disable all
|
||||
hooking* was switched on **before** the games were started, not while one was being recorded: Cyberpunk 2077
|
||||
(06:34) and Phantom Blade Zero (06:38) were each recorded as `RefusedKillSwitch` — tier 2, nothing injected, no
|
||||
overlay log for either process, which is FR-2.4 doing what it says and not what (d) asks. With the switch off
|
||||
again, Phantom Blade Zero (06:46, 518 s) was hooked from its start to its exit: twenty-two patches under one
|
||||
batch of 84 ms and ray tracing's two under one of 81 ms, ×3.0 at 89 → 268, no fault, a clean exit — and **no
|
||||
`STOP`, no `UNHOOK_RESTORED`, no `PATCH_BATCH restore` line**, because nothing stopped it while it ran. Windows'
|
||||
application log has no fault since 06:30. **How (d) is run**: start the game with the switch **off** and wait
|
||||
until FrameLedger shows it recording; **then**, with the game still running, switch *Disable all hooking* on;
|
||||
play on for half a minute; switch it off; close the game.
|
||||
**2026-11-14, the second try (sessions 206 and 207, Phantom Blade Zero): (d) held, twice.** The game started with
|
||||
the switch off and was being recorded; the switch was turned on while it ran. Each log has `STOP` at the next
|
||||
safety scan, an `UNHOOK_RESTORED` line for every one of the twenty-nine patches at one time, one `PATCH_BATCH
|
||||
restore` — `a=83309` and `a=85578`, `b=0x1d` — and `STOP_FLUSHED … a=1`; no `UNHOOK_DECLINED`. Both sessions
|
||||
ended `KillSwitchEngaged`, tier 1, no fault, nothing dropped; the game ran on for three and four minutes and
|
||||
closed with nothing in Windows' application log. Whether a hitch was felt at the stop is the owner's to say.
|
||||
**Taken as passed for what 0.1.0-beta.47 was held on** — (a), (b), (d), (f). **(e) and (g) were never run**: they
|
||||
are (f) and (g) of item 45.
|
||||
45. **beta.47 — NVIDIA's latency report, read inside a game** (D132, D136, D138–D141). **Cyberpunk 2077 first**
|
||||
(D136), **and not first on a game under the user-mode exception's trial** (D38): a crash there ends the exception for good.
|
||||
This is the first release in which the part inside a game *makes a call of its own* — into the graphics driver,
|
||||
about once a second, on the game's presenting thread — so read (a) before (b). (a) **The update**: Help ▸ Check
|
||||
for updates, *Restart to update* with no game running; **the terms window shows once, with Privacy Policy 2.20
|
||||
and Disclaimer 2.16** — the Disclaimer's §2 has a new paragraph, *One call it makes itself, into the graphics
|
||||
driver*. Settings ▸ *Advanced metrics* says the same in its description. (b) **Cyberpunk 2077, Advanced metrics
|
||||
on, frame generation OFF, Reflex on in the game's menu**, five minutes of play, then close the game as usual.
|
||||
Its `logs\overlay-<pid>-….log` has `LATENCY` lines: *reading the driver's latency report*, and two more with
|
||||
the end of two paths — `…\System32\nvapi64.dll` and `…\nvapi64_impl.dll`. On the Advanced page, the session
|
||||
has a group **Latency**: the table *What the driver's low-latency state is* (five rows by NVIDIA's names, and
|
||||
`fgMultiplier`) and, in the chart's list, *Latency per frame* with seven lines. The line under the session ends
|
||||
with *NVIDIA's latency report, which FrameLedger asks the graphics driver for inside the game: read.* Say the
|
||||
*total* line's usual value, and **whether the game felt any different with the option on** — a hitch once a
|
||||
second is the thing to look for. (c) **The same with frame generation ON** (DLSS ×2 or more): the driver's
|
||||
pacer is another thread, and this is the arrangement the probe could not make. (d) **Reflex switched off in the
|
||||
game's menu**, if the game lets you: say what the line reads — *read* or *asked, and the driver reported no
|
||||
frame*; both are possible and neither is wrong. (e) **Only after (b) and (c) are clean, a second game** that
|
||||
uses Reflex through Streamline (Phantom Blade Zero, Clair Obscur, Black Myth: Wukong, Hogwarts Legacy). (f) **A
|
||||
game that is not Direct3D 12 or has no NVIDIA library** (Kingdom Come: Deliverance II, Lies of P): the line
|
||||
reads *not read*, with which of the two. (g) **Off means off**: with Advanced metrics off, start a game afresh;
|
||||
its log has no `LATENCY` line. (h) **Nothing else moved**: no fault counted, frame rates and the
|
||||
frame-generation factor as before, the game closes as it did.
|
||||
**What each outcome means, written before the run.** *Read*, with a total of a few to a few tens of
|
||||
milliseconds that moves with the frame rate: route D works in a real game; what comes next — more titles, the
|
||||
session summary — is the owner's to say. *Asked, and the driver reported no frame* in a game whose Reflex is
|
||||
on: the driver has a report for another object than the device FrameLedger holds; nothing is harmed, and the
|
||||
title is not readable this way. *Not read — the game has not loaded nvapi64.dll* in Cyberpunk 2077: what its
|
||||
files said did not happen at run time; another title is tried. *Stopped — a call took N µs*: **one call of a few
|
||||
thousand microseconds, once, is most likely a pause of the game's thread on a busy PC** (`spike-notes` §31, *A
|
||||
run on a busy PC*) — start the game again and see whether it repeats; if it repeats, or N is ten thousand or
|
||||
more, the driver holds the call in that game and **route D stops for it** — say so with the number. *Stopped — a
|
||||
call into the driver faulted*, or a fault counted in the session: **route D stops** (the commitment of §30) —
|
||||
say so at once, with the log. **A game that freezes** with a `LATENCY` line saying a call has not returned, or
|
||||
that freezes at all with the option on and not with it off: close it, say so at once; Advanced metrics off is
|
||||
the way to play it, and route D ends. **A hitch once a second** with the option on that is not there with it
|
||||
off: say so at once — the two-millisecond latch did not catch what a player can feel. **The game closing by
|
||||
itself a second or two after it starts, only with the option on** (Windows' Application log: exception
|
||||
`0xc0000409`): a Control Flow Guard refusal of the call — say so at once with the entry; that game enforces
|
||||
what the probe could only check for this driver. Spans that make no sense — a part larger than the total, a
|
||||
line that is always zero: say which; they are the driver's numbers and are shown as it reported them.
|
||||
**Three sessions were run on 2026-11-14 and read the same morning — in Phantom Blade Zero, not Cyberpunk 2077**
|
||||
(sessions 208–210, Direct3D 12, Streamline 2.14.1). **The read works in a real game.** (a) held: the terms were
|
||||
accepted once, Disclaimer 2.16 and Privacy Policy 2.20. In all three the overlay log has `LATENCY … reading the
|
||||
driver's latency report` four to five seconds after the attach, with `C:\WINDOWS\SYSTEM32\nvapi64.dll` and
|
||||
`…\nvapi64_impl.dll` on the two lines after it, and **no later `LATENCY` line**: no error, no slow call, no
|
||||
fault, no stall. Each session's line reads *read*, and the slowest call into the driver was **24, 20 and 45 µs**.
|
||||
Frame generation on: session 208, ×3.0 at 85 → 256 — and the driver's own `fgMultiplier` read 3. Off: sessions
|
||||
209 and 210, multiplier 1. Seven series in each, 227 / 24 / 823 points: 90 %, 62 % and 98 % of the Agent's own
|
||||
once-a-second samples (the short session spent its first seconds before the module was found). With frame
|
||||
generation ×3: total 23.4 ms, simulation 4.4, render submit 10.3, present 0.7, driver 10.9, OS queue 13.0, GPU
|
||||
render 11.5 (means). The driver's switches: `bLowLatencyMode`, `bUseGameSleep` and `bFullscreenIFlip` *on at
|
||||
times, off at others*; `bFsVrr` and `bCplVsyncOn` *off* — so in a game the low-latency switch does read on,
|
||||
which it never did for the probe. No fault counted, nothing dropped, a normal exit each time, nothing about the
|
||||
game in Windows' application log; rates as on beta.46 for the same game.
|
||||
**One outcome the list above names: a part larger than the total.** *GPU render* reads 16.4 ms where the *total*
|
||||
reads 5.4 ms (session 209), and about equals it in session 210 (16.0 against 15.9 ms). The span is the driver's
|
||||
`gpuRenderStartTime` to `gpuRenderEndTime`, and in this game that start lies **before** the frame's own
|
||||
simulation start: it reads like the time between two frames' GPU ends, idle time included — a reading, not a
|
||||
fact; the driver has a field of its own for the active time (`gpuActiveRenderTimeUs`), which FrameLedger does
|
||||
not read. It is shown as the driver reported it. The spans also overlap — render submit, driver and OS queue
|
||||
together are longer than the total — so they are not parts that add up, and the page does not say they are.
|
||||
**Not run**: Cyberpunk 2077, which (b) and (c) name; (d) Reflex off in the game's menu; (f) a game that is not
|
||||
Direct3D 12 or has no NVIDIA library; (g) off means off. **Not said**: whether the game felt any different with
|
||||
the option on. Not passed as written; what the three sessions were run for is answered.
|
||||
**Five more sessions the same morning (211–215), read at 09:15: Cyberpunk 2077 twice, and three games the
|
||||
read must leave alone.** (b), (c) **Cyberpunk 2077** (Streamline 2.14.1, DLSS): session 211 with frame
|
||||
generation ×2.0 for 42 % of it (166 → 330) and menus for the rest, session 212 without, at 238 FPS. The module
|
||||
was found 4.8 s and 2.6 s after the attach, in the same two files; each session's line reads *read*; **the
|
||||
slowest call took 34 and 65 µs**; no later `LATENCY` line. 190 of 195 and 429 of 438 samples carry a report.
|
||||
The total: 13.5 ms while frames were generated, 4.1 ms in the menus, 11.7 ms at 238 FPS without generation.
|
||||
**GPU render is 2.7 ms there and never longer than the total** (0 of 429 samples; 1 of 190) — so what the
|
||||
three sessions above showed is Phantom Blade Zero's, not the route's. `bLowLatencyMode` *on* throughout. The
|
||||
table's `fgMultiplier` reads **1 in the session that held ×2 for 105 seconds**: the row keeps the last value
|
||||
read, and that session ended in a menu — a row that lists what was seen would not mislead. D137's first
|
||||
Cyberpunk batches: eight of them, 85–221 ms, every one `install` in one apply; beta.46's 0.61 s did not recur.
|
||||
(f) **Not Direct3D 12**: Crown & Coin (213) and Psycho-Sleuth (214), both Direct3D 11 — one `LATENCY no
|
||||
Direct3D 12 device` line each, nothing after it, the session's line reads *not read — not Direct3D 12*.
|
||||
**Direct3D 12 with no NVIDIA library**: Dread Fields (215) — `the game has not loaded nvapi64.dll`, said once,
|
||||
*not read*. The three ran at the same time and were recorded apart. (h) held in all five: no fault counted,
|
||||
nothing dropped, normal exits, nothing in Windows' application log.
|
||||
**A correction to the paragraph above**: the Agent's samples are **1.32 s apart, not one second** (the `t_ms`
|
||||
series; so in every session looked at back to beta.42, while `sensor_blobs.hz` says 1.0 — not looked into),
|
||||
so the shares are 227 of 258, 24 of 39 and 823 of 846 samples, and the gaps are the first seconds of a session.
|
||||
**The owner's answer on the *GPU render* line (2026-11-14): read the driver's active time** — planned as one
|
||||
train with what else is open. **Left of this item**: (d) Reflex off in the game's menu, (g) off means off, and
|
||||
the owner's word on how the games felt; the owner runs what is left once, with that train's release.
|
||||
**They are (d), (e) and (g) of item 46.**
|
||||
46. **beta.48 — the driver's own GPU times, the multipliers seen, samples a second apart; and what item 45 left**
|
||||
(D142–D146). **One batch**, as the owner asked: any Direct3D 12 games that use Reflex, as many as wanted, with
|
||||
*Advanced metrics* on — **not first on a game under the user-mode exception's trial** (D38). Then say *check*;
|
||||
the sessions are read from a copy of the ledger and the logs.
|
||||
(a) **The update** shows the terms window once, with **Privacy Policy 2.21 and Disclaimer 2.17**.
|
||||
(b) **Phantom Blade Zero and Cyberpunk 2077 again**, a few minutes of play each: on the Advanced page, under
|
||||
**Latency**, a second chart — *the graphics card's time per frame, as the driver works it out* — with two lines,
|
||||
*GPU active render* and *GPU frame time*; and the old line reads *GPU render, start to end (idle time included)*.
|
||||
(c) **A session with both a menu and frame generation**: the table's `fgMultiplier` row lists both — *1, 2*, or
|
||||
*1, 3* — not the last one.
|
||||
(d) **Reflex switched off in a game's menu**, if a game lets you (item 45 (d)): say what the session's line reads.
|
||||
(e) **Off means off** (item 45 (g)): switch *Advanced metrics* off, start a game afresh, play a minute, close
|
||||
it; switch it back on afterwards.
|
||||
(f) **Any other games of the batch** — Clair Obscur, Black Myth: Wukong, Hogwarts Legacy, Dread Fields, a
|
||||
Direct3D 11 game: nothing to do but play and close them.
|
||||
(g) **How the games felt** with the option on — a hitch once a second is the thing to look for; nobody but the
|
||||
player can say it.
|
||||
**Read from the ledger, nothing for the owner to do**: the samples of every session are one second apart, not
|
||||
1.32 s, and `hz` says what they were.
|
||||
**What each outcome means, written before the run.** *The two lines are there, and active render is shorter
|
||||
than GPU render*: D142 did what it was for; in Phantom Blade Zero the reading of 2026-11-14 expects *GPU frame
|
||||
time* near the 16 ms the old line showed, and *active render* well under it — **if active render is as long as
|
||||
the old line there, that reading was wrong**, and the span is long for another reason: say the numbers. *The
|
||||
second chart is not there, and the seven lines are*: the driver gave zero for both figures in every frame —
|
||||
nothing is wrong with the read, and the texts already say a driver may give neither; say which game. *One line
|
||||
and not the other*: the same, for one figure. *Active render longer than GPU render, start to end*: they are the
|
||||
driver's numbers and are shown as reported — say which game and by how much. *`fgMultiplier` shows one value in
|
||||
a session that had both*: the driver's status did not change with the menu in that game, or the mask is wrong —
|
||||
say the game; the log's `LATENCY` lines and the frame-generation mix of the session tell the two apart. *Samples
|
||||
still 1.3 s apart*: the period is not kept — the poll takes longer than the interval, or the change is not in
|
||||
the build: stop and say so. *Samples a second apart and the Agent's processor use visibly higher*: a poll that
|
||||
took a third of 1.32 s now takes a third of a second — say so; where that time goes is not established
|
||||
(§Left open). *(d) reads "read"*: the driver reports frames with the game's Reflex off — both that and *asked,
|
||||
and the driver reported no frame* are possible and neither is wrong. *(e) the log has a `LATENCY` line*: off
|
||||
does not mean off — say so at once, with the log. **A fault, a freeze, a game closing by itself, a hitch every
|
||||
second, or a session that says *stopped***: as item 45 says for each — say so at once.
|
||||
**Run 2026-11-14, 12:49–14:12, and read the same afternoon** from a copy of the ledger and the logs: ten
|
||||
sessions on beta.48 — Phantom Blade Zero seven times (217, 219, 220, 223–226), Cyberpunk 2077 three times (218,
|
||||
221, 222). Every one tier 1, exit code 0, no fault counted, nothing dropped; nothing in Windows' application
|
||||
log. (Session 216, an hour of Phantom Blade Zero, was still beta.47 — it ran while the release was cut — and
|
||||
is 1.32 s apart like the ones before it.)
|
||||
**The samples are a second apart**: the median gap is 996–1002 ms in all ten (session 223: 2 294 of 2 394 gaps
|
||||
round to 1.00 s, the rest lie between 0.80 and 1.27 s), and `hz` reads 1.000–1.017.
|
||||
(a) `legal_acceptance` holds Privacy Policy 2.21 and Disclaimer 2.17, accepted at 12:48:40.
|
||||
(b) **Both figures were given by both games, in every frame report**: in the nine sessions with the option on,
|
||||
every sample that has a *GPU render* span has both (3 834 of 3 834). **Phantom Blade Zero is what the reading of
|
||||
2026-11-14 expected**: at 60 FPS (217) the span's median is 16.39 ms, *GPU frame time* 16.67 ms and *GPU active
|
||||
render* **9.59 ms**; in the menu (224) 16.39 / 16.67 / **2.77**; at 91 FPS (225) 11.49 / 11.79 / 10.05; with
|
||||
frame generation ×5 (223) 15.67 / 15.88 / 14.08. So in that game the span is the time from one frame to the
|
||||
next less a third of a millisecond, whatever the card did in it, and active render is never longer than it
|
||||
(0 of 3 406 samples). **Cyberpunk 2077 is the outcome written above as "active render longer than GPU render,
|
||||
start to end"**: without frame generation it is longer at 157 of 158 samples (218: medians 3.17 against
|
||||
2.79 ms, frame time 6.02) and at 48 of 48 (221: 2.03 against 1.82, frame time 2.37); with frame generation ×2
|
||||
(222) it is shorter at all 222 (4.85 against 6.35, frame time 6.67). Shown as reported. **Why is not
|
||||
established**, and two things could do it: the two are averages over different frames — the span over every
|
||||
summed frame, one of no length included (the smallest mean span of a sample there is 0.5 µs, the smallest active
|
||||
time 0.29 ms), active render over the frames that gave one — or the driver counts work the two marks do not
|
||||
enclose. The ledger cannot tell them apart; a count of the frames whose span has no length would.
|
||||
(c) `fgMultiplier` reads **1, 2** in Cyberpunk 2077 (222: ×2.0 for 69 % of it), **1, 5** in Phantom Blade Zero
|
||||
(220: ×5.0 for 71 %, 30 → 151 FPS; 223: ×5.0 for 95 %, 63 → 316) and **1** in the seven sessions that generated
|
||||
nothing.
|
||||
(d) **Session 221** (Cyberpunk 2077, 59 s of menus at 421 FPS) is the only Cyberpunk session whose
|
||||
`bLowLatencyMode` reads *on and off* — 218 and 222 read *on*, as 211 and 212 did — and is taken to be the one
|
||||
where Reflex was switched off; the owner has not said which it was. Its line reads *read*, 48 of 57 samples
|
||||
carry a report, every one from the first on, and the slowest call took 19 µs: the driver goes on reporting
|
||||
frames.
|
||||
(e) **Off means off, on a real game for the first time**: session 226 (`telemetry.advanced` 0) has no
|
||||
`session_advanced` row and 19 series where the others have 240; its log has ten hooks, none of the ones
|
||||
Advanced metrics adds, and **no `LATENCY` line**. The setting was still off when the ledger was copied.
|
||||
(f) No other game was in the batch.
|
||||
**The read itself**: one `reading the driver's latency report` line a session, 1.4–6.7 s after the attach, in
|
||||
the same two files, and none after it; the slowest call of a session 18–123 µs; no latch. The install batches
|
||||
took 75–191 ms, every one `install`.
|
||||
**Samples with no report**: after a session's first report, 0.4–7.3 % of its samples carry none (1 of 223 in
|
||||
222; 134 of 2 377 in 223, minutes of four in five there). They are not the sensor library's ticks (25 of the 134
|
||||
fall on one, 24 just after one). What the code says, not measured: the watchdog ticks once a second and arms a
|
||||
read when a second has passed since the last arm, so a tick that comes a moment early waits for the next one —
|
||||
the reads are a second apart or two, the samples exactly one. Nothing is lost by it; a sample shows a gap.
|
||||
(g) **The owner's answer, asked whether a game hitched once a second with the option on (2026-11-14): no
|
||||
hitch.** What the frames say, in the sessions without frame
|
||||
generation: a frame three times the median of the 120 before it and 8 ms longer comes 0.33 times a second
|
||||
with the option on (225) and 0.32 with it off (226), and such frames do not gather at a period of one second
|
||||
(vector strength 0.05–0.10 where chance gives 0.10–0.20; 217, 218 and 222 the same). Sessions with frame
|
||||
generation cannot be judged that way. **Not seen in the ledger**: what the page looked like, and the Agent's
|
||||
processor use now that a poll comes every second.
|
||||
**Read, and (g) answered**: (a)–(g) each have their answer; ~~whether session 221 was (d) is inferred, and the
|
||||
owner's to say~~ (d) is withdrawn in the next paragraph. The owner has not said the item is passed.
|
||||
**Eight more sessions the same afternoon (227–234), read at once, and three things the owner said.** Still
|
||||
beta.48: Cyberpunk 2077 three times (227 with the option off — no `LATENCY` line, no row; 232 mostly menus; 233
|
||||
five minutes without frame generation), Phantom Blade Zero three times (228, 231, 234), Clair Obscur:
|
||||
Expedition 33 twice (229 with frame generation ×3 for 79 % of it, 230 without). All tier 1, exit code 0, no
|
||||
fault, nothing dropped; samples a second apart; slowest calls 10–29 µs; `fgMultiplier` *1, 3* in 229.
|
||||
**The owner's words**: *Reflex is checked together with frame generation — without frame generation the game
|
||||
does not switch Reflex on*; *a value that reads on and off is the NVIDIA App's override* (the App's page for
|
||||
Phantom Blade Zero: **Low Latency Mode — Ultra**); and a session with Reflex off may be read. **So (d) above
|
||||
is withdrawn as written**: session 221 was not "the one where Reflex was switched off in a menu", and nothing
|
||||
here says what its `bLowLatencyMode` *on and off* was. What the sessions do read: **Clair Obscur without frame
|
||||
generation has `bUseGameSleep` off throughout (230) and with ×3 on and off (229)** — the game's own Reflex
|
||||
goes with its frame generation, as the owner said; **Phantom Blade Zero has `bLowLatencyMode` off throughout
|
||||
in 234**; and in both the read is what it is with Reflex on — one `reading` line, a report at every read, the
|
||||
two new figures in every one. **Cyberpunk 2077 without frame generation again has active render longer than
|
||||
the span** (233: 3.40 against 3.13 ms at 292 of 296 samples), **and its menus do not** (232: 0 of 126; active
|
||||
0.39 ms inside a span of 1.18).
|
||||
**The holes are larger in short sessions**: 11.3 %, 16.2 % and 11.1 % of the samples after the first report
|
||||
in 228, 229 and 231; 6.0 % in 230; 0.8 % in 232. **And "nothing is lost by it", above, was wrong**: it was
|
||||
written on a reading of the Overlay alone. The Agent kept one set of readings until a sample carried it and
|
||||
overwrote it — a publication that landed just after a sample left that sample without, and the set that had
|
||||
waited was replaced at the next return to step (46 of session 223's 134 holes are exactly five samples
|
||||
apart). The Overlay's part is the other half: its ticks were a second and their own work apart, and a tick the
|
||||
loader woke published the read and armed none. Both are mended in 0.1.0-beta.49 (D150); neither is measured in
|
||||
a game yet.
|
||||
47. **beta.49 — whose the difference is in Cyberpunk 2077's GPU times; and the holes** (D148–D151). **One batch,
|
||||
in pairs**: the same game with frame generation off and with it on, *Advanced metrics* on. Reflex is not
|
||||
switched by hand — it goes with frame generation. **Not first on a game under the user-mode exception's
|
||||
trial** (D38). Then say *check*; the logs and a copy of the ledger are read.
|
||||
(a) **The update shows no terms window**: no legal text changed.
|
||||
(b) **Cyberpunk 2077**: six minutes or more of play **without frame generation**, in a scene like session
|
||||
218's; six minutes or more with **frame generation ×2**; two minutes of menus only.
|
||||
(c) **Phantom Blade Zero**: six minutes or more without frame generation — the control — and six or more with.
|
||||
(d) **About eight short sessions**, three minutes each, any Direct3D 12 game that uses Reflex: the step between
|
||||
the game's side and the Agent's is different in every session, and one long session shows one of them.
|
||||
(e) **One session with *Advanced metrics* off**; switch it back on afterwards.
|
||||
(f) **What *Low Latency Mode* is set to for Cyberpunk 2077 in the NVIDIA App** — a word is enough.
|
||||
(g) **How the games felt**, as always.
|
||||
A game closed by itself loses its last batch of counts, under a minute: that is why six minutes and not two.
|
||||
**What each outcome means, written before the run.** The log's `LATENCY_FRAMES` batches each carry the state
|
||||
they belong to, so every one is read as *this state, these counts*.
|
||||
*Cyberpunk without frame generation: nearly every frame that has both is in "active longer than span", and
|
||||
their mean span is near the 2.8 ms the chart shows* — **the difference is the driver's**: it counts work the
|
||||
two marks do not enclose. The numbers are shown as reported and the label "idle time included" is what is
|
||||
wrong for that game: the owner decides its wording.
|
||||
*"Active longer" is a minority whose spans are next to nothing, the rest have active within the span, and
|
||||
spans of no length or of a microsecond are about as many as that minority* — **the difference is ours**: the
|
||||
span's mean is pulled down by frames that have none. The owner decides whether the mean is taken over the
|
||||
frames that have a span.
|
||||
*Both heaps are large, with real spans* — both; the heaps' sums give the like-for-like figure, and it is said
|
||||
with them.
|
||||
*"GPU span absent" is not zero* — those reads published no GPU point at all, and were never in the comparison.
|
||||
*Phantom Blade Zero shows many frames in "active longer"* — suspect the count before the driver: say so.
|
||||
*The counts differ between a batch with `bUseGameSleep` on and one with it off, in the same game* — that is
|
||||
the owner's point, measured: say the two side by side.
|
||||
*The batches say a thousand milliseconds a read and as many periodic ticks as reads, and every session has
|
||||
next to no sample without a report* — D150 did what it was for.
|
||||
*The log says a thousand milliseconds a read and some sessions still lack a report at a steady share of their
|
||||
samples* — the Agent's rule is not the whole of it: say the sessions and the share.
|
||||
*The log says more than a thousand milliseconds a read* — the Overlay is still uneven; the line's tick counts
|
||||
say whether the loader was waking it.
|
||||
*(e) has a `LATENCY` or `LATENCY_FRAMES` line* — off does not mean off: say so at once, with the log.
|
||||
**A fault, a freeze, a game closing by itself, a hitch every second, or a session that says *stopped***: as
|
||||
item 45 says for each — say so at once.
|
||||
**Run 2026-11-14 (sessions 236–245, ten on 0.1.0-beta.49), read the same day** from a copy of the ledger and
|
||||
the Overlay's logs. All ten tier 1, exit code 0, no fault, nothing dropped. Phantom Blade Zero twice (236
|
||||
without frame generation, 1 108 s; 237 with ×2, 811 s), Kingdom Come: Deliverance II (238), Clair Obscur (239),
|
||||
Black Myth: Wukong (240), Lies of P (241, and 245 with the option off), Hogwarts Legacy (242), Dying Light: The
|
||||
Beast (243), Cyberpunk 2077 (244). 239 and 240 ran at the same time, and so did 241, 242 and 243.
|
||||
(a) **No new acceptance row** after the update: the terms window did not appear.
|
||||
(b) **Cyberpunk 2077 was one session of 125 s without frame generation** (374 FPS); ×2 and the menus were not
|
||||
run. It is enough for the question. 88 reads in one state — low-latency mode on, the game sleeping, ×1 — summed
|
||||
5 394 frames: **4 917 in "active longer than span", mean span 1 571 µs, mean active 1 849 µs**; 96 within
|
||||
(3 866 / 3 431 µs); 381 with a span of no length and an active time; none absent, none refused. **So the
|
||||
difference is the driver's**: on frames that have a real span, its active time is 278 µs (18 %) longer than
|
||||
the two marks are apart. A small part is ours as well — 7 % of the frames have a span of no length and pull the
|
||||
span's mean down (the stored means are 1 892 and 2 138 µs). With frame generation on it is not measured on
|
||||
this build (0.1.0-beta.48's means: never longer).
|
||||
(c) **The count is not what is wrong**: in the six other sessions that reported (five games), **not one frame of 129 900** is
|
||||
in "active longer", and no span is absent or of no length. Phantom Blade Zero: without frame generation
|
||||
63 123 frames, span 16.4 ms, active 11.1 ms; with ×2 21 209 frames, span 33.2 ms, active 12.6 ms.
|
||||
(d) **The holes**: in batches of twenty reads or more a read took 1 000.94 ms (236), 997.18 (237), 999.99 (242,
|
||||
244), and up to 1 013 ms in the sessions that shared the PC with another game. Samples without a
|
||||
report: 236 — 40 of 1 106, **39 of them in the first 46**, while the game started; 237 — 36 of 809, in the first 42 and
|
||||
the last two; 244 — 9 of 123, in the first ten. Before, they were spread through a session (0.4–16 %). **D150 did what
|
||||
it was for.** Where two or three games ran at once the holes are blocks in which the game did not present
|
||||
(240: 103 of 477; 242: 80 of 402, 68 of them at its start; 243: 37 of 414; 239: 23 of 184): a read is taken on
|
||||
the presenting thread, so a game that presents nothing is not read — Lies of P's log has sixty reads in 189 s.
|
||||
(e) **Off means off**: session 245 has no `LATENCY` line and no Advanced row.
|
||||
**The stop fired in a real game for the first time** (D141): Kingdom Come: Deliverance II, 12 s after the
|
||||
attach, while the game was starting — the seventh read took 5 337 µs, and no further read was made; the
|
||||
session says so (`Slow`), the game ran 287 s and closed normally. No frame had been reported in those seven
|
||||
reads. **The owner: that game has no Reflex in its settings** — so there was no report to lose; the
|
||||
session's line says *stopped* where, without the slow call, it would have said *the driver reported no
|
||||
frame*. Elsewhere the slowest call was 22–235 µs. In Lies of P the driver reported no frame at all.
|
||||
**What the states say of Reflex and frame generation** (each batch carries its own): low-latency mode was
|
||||
**on at a multiplier of 1** in Cyberpunk 2077 (88 reads), Black Myth: Wukong (253), Hogwarts Legacy (299) and
|
||||
Dying Light: The Beast (345); Phantom Blade Zero without frame generation sleeps through Reflex with
|
||||
low-latency mode **off** (1 062 reads) and switches it on with ×2; Clair Obscur without frame generation has
|
||||
both off and still reports its frames. The logs cannot say whether a game's menu or the NVIDIA App switched
|
||||
the mode on. NVIDIA's own guide makes frame generation need Reflex and not the reverse
|
||||
(`spike-notes` §30, *Added 2026-11-14*). Hogwarts Legacy gave a multiplier of 6 for seventeen reads.
|
||||
(f), (g) **The owner, the same evening: "App reflex off, không khựng"** — *Low Latency Mode* is off in the
|
||||
NVIDIA App, and no hitch. Read with (f) as it was asked, for Cyberpunk 2077: the low-latency mode its 88
|
||||
reads show at a multiplier of 1 is then the game's own Reflex and not the App's override — Reflex on without
|
||||
frame generation, as NVIDIA's guide allows. **Then shown, in two screenshots**: the NVIDIA App's *Program
|
||||
Settings* for Cyberpunk 2077 have *Low Latency Mode* **Off**, set for that program (the rows that follow the
|
||||
global setting read "Global - …"; this one does not); and the game's own *Video* page has **NVIDIA Reflex Low
|
||||
Latency: On**, V-Sync off, borderless at 2560×1440, 378 FPS on the game's counter. So the driver's
|
||||
`bLowLatencyMode` on, at a multiplier of 1, is the game's menu, seen from both sides. **The owner's**: the wording of the two GPU labels — *idle time excluded /
|
||||
included* does not describe a game whose active time is the longer.
|
||||
|
||||
**Answered 2026-08-05, do not re-ask:** remove `gameguard` and keep `guard` (approved
|
||||
over a red `Rules` gate, with the reasoning recorded in the merge commit); vendor NVAPI
|
||||
@@ -769,6 +1156,38 @@ Where each owner decision is recorded — the file and its section, and a label
|
||||
| D129 | [`18_GPU_VENDOR_APIS.md`](18_GPU_VENDOR_APIS.md) §Train B | `slInit` is not hooked at all — asked to reopen D112 and shown that no shipped mode is in the game in time (launch mode waits for the presentation runtime, no patch is ever made on a game's thread, an Advanced-only hook waits for the Agent's request), the owner kept it out; a hook there would be a patch that reads nothing |
|
||||
| D130 | [`18_GPU_VENDOR_APIS.md`](18_GPU_VENDOR_APIS.md) §Train B | six more Streamline core calls are hooked in one release, 0.1.0-beta.45 — `slIsFeatureSupported`, `slIsFeatureLoaded`, `slSetFeatureLoaded`, `slAllocateResources`, `slFreeResources`, `slShutdown`; trains C and D come after it, and train C's spike is written beside it as a document |
|
||||
| D131 | [`17_HOOK_ENGINE.md`](17_HOOK_ENGINE.md) §Hook inventory | the adapter a game asks `slIsFeatureSupported` about (`sl::AdapterInfo`: a LUID, or a Vulkan physical device) is never read — the feature's id and the result only; a build check refuses the struct's member names in code loaded into a game |
|
||||
| D132 | [`20_OPEN_QUESTIONS.md`](20_OPEN_QUESTIONS.md) §M14, `CLAUDE.md` rule 4's note of 2026-11-13 | Reflex route D goes to a spike on `hook-harness` and a stub first — and the ruling a go needed: calling a driver's read-only getter with the device of the swap chain the Overlay hooks is inside rule 4. No real game before the owner has seen the result |
|
||||
| D133 | [`20_OPEN_QUESTIONS.md`](20_OPEN_QUESTIONS.md) §M14, [`spike-notes/30-reflex-latency.md`](spike-notes/30-reflex-latency.md) | Reflex route C (the Overlay calling `slReflexGetState`) is refused; the no-injection ETW route stays closed, and §G with it |
|
||||
| D134 | [`17_HOOK_ENGINE.md`](17_HOOK_ENGINE.md) §Unhooking, *Batches* | installs and restores are batched through MinHook's queue — one stop of the game's threads for a batch, not one a patch — in a pull request of its own, measured, released alone (0.1.0-beta.46) |
|
||||
| D135 | [`17_HOOK_ENGINE.md`](17_HOOK_ENGINE.md) §Hook inventory | `slAllocateResources` keeps its patch although no game called it in the first six sessions; looked at again when there are more |
|
||||
| D136 | [`20_OPEN_QUESTIONS.md`](20_OPEN_QUESTIONS.md) §M14, [`spike-notes/31-reflex-route-d-harness.md`](spike-notes/31-reflex-route-d-harness.md) §The question for the owner | Reflex route D goes on to one real title, Cyberpunk 2077 — a plan of its own first, no code before it is approved, and no release carrying it before item 44 (d) has been run |
|
||||
| D137 | [`17_HOOK_ENGINE.md`](17_HOOK_ENGINE.md) §Unhooking, *Batches* | the `PATCH_BATCH` line says how a batch ended — one apply, or finished one patch at a time — after two batches in real games took 0.61 s and 1.26 s and the log could not say which; with the next release, not one of its own |
|
||||
| D138 | [`20_OPEN_QUESTIONS.md`](20_OPEN_QUESTIONS.md) §M14, [`handoff/history/0.1.0-beta.46.md`](handoff/history/0.1.0-beta.46.md) §The train after 0.1.0-beta.46 | the Reflex read has no switch of its own: it is part of Advanced metrics — so it reaches every Direct3D 12 game that loaded the driver's `nvapi64.dll`, for everyone who switched Advanced metrics on; "one title" is the order of the owner's first runs (item 45), not a limit in code |
|
||||
| D139 | [`spike-notes/31-reflex-route-d-harness.md`](spike-notes/31-reflex-route-d-harness.md) §The leg with a sleep | before any Overlay code the probe runs a leg with `NvAPI_D3D_SetSleepMode` and `NvAPI_D3D_Sleep` — writes, in the probe's own process, on its own device, in no shipped binary |
|
||||
| D140 | [`20_OPEN_QUESTIONS.md`](20_OPEN_QUESTIONS.md) §M14 | an `nvapi64.dll` loaded from the game's own folder — a replacement, not the driver's — is refused, and the session says why |
|
||||
| D141 | [`20_OPEN_QUESTIONS.md`](20_OPEN_QUESTIONS.md) §M14 | one call into the driver of 2 ms or more switches the Reflex read off until the game exits |
|
||||
| D142 | [`17_HOOK_ENGINE.md`](17_HOOK_ENGINE.md) §Calls the Overlay makes into a driver | asked on 2026-11-14 with Phantom Blade Zero's *GPU render* longer than its total: read the driver's `gpuActiveRenderTimeUs`, and with it `gpuFrameTimeUs` — two more members of the report already fetched, no further call |
|
||||
| D143 | [`18_GPU_VENDOR_APIS.md`](18_GPU_VENDOR_APIS.md) §The inventory | the start-to-end *GPU render* line stays, stored and shown, under a label that says it includes the card's idle time |
|
||||
| D144 | [`07_IPC.md`](07_IPC.md) §Region 5 | the driver's frame-generation multiplier is kept as every value a session saw, not the last one |
|
||||
| D145 | [`../legal/ACCURACY.md`](../legal/ACCURACY.md) | the accuracy statement, the README and the guide say two real games were read on one driver (they said none); Privacy Policy 2.21 and Disclaimer 2.17 with it |
|
||||
| D146 | [`06_DATA_MODEL.md`](06_DATA_MODEL.md) §sensor_blobs | the Agent's samples were 1.32 s apart under a 1 s setting (it waited the whole interval after its work): sample on a fixed period, and store the rate the samples had |
|
||||
| D147 | [`03_METRICS.md`](03_METRICS.md) | the session summary's latency fields stay N/A: the driver's total is simulation start to GPU end, not input to display |
|
||||
| D148 | [`17_HOOK_ENGINE.md`](17_HOOK_ENGINE.md) §Native logging | asked on 2026-11-14 with item 46's Cyberpunk 2077 numbers (active render longer than the span between the GPU marks): count the frames, and write the counts **only to the Overlay's native log** — no layout, schema, App or string change |
|
||||
| D149 | [`17_HOOK_ENGINE.md`](17_HOOK_ENGINE.md) §Native logging | told that a bug report carries the five newest Overlay logs and so these lines: **no change to the legal texts** — the Privacy Policy names the logs of the component loaded into games, and the lines are counts and sums of microseconds |
|
||||
| D150 | [`07_IPC.md`](07_IPC.md) §Region 5 | the samples that carry no report are mended **on both sides**: the Overlay reads and publishes on a grid of one second, and the Agent no longer overwrites a reading that waits for a sample |
|
||||
| D151 | [`17_HOOK_ENGINE.md`](17_HOOK_ENGINE.md) §Native logging | the owner's word: Reflex is checked together with frame generation — without it the owner's games do not switch Reflex on, and a low-latency switch that reads on and off is the NVIDIA App's override. A batch of counts belongs to one state of the sleep status |
|
||||
| D152 | [`18_GPU_VENDOR_APIS.md`](18_GPU_VENDOR_APIS.md) §The inventory | the two GPU labels say what each figure is — *the driver's own figure*, *between the driver's start and end marks* — not "idle time excluded / included": item 47 counted the active time as the longer in Cyberpunk 2077. Strings only; numbers and means unchanged |
|
||||
| D153 | [`spike-notes/30-reflex-latency.md`](spike-notes/30-reflex-latency.md) *Added 2026-11-14* | the owner's word: of Reflex it is enough to tell whether a game has it. Reflex and PCL leave train D (`sl.pcl.markers` stays refused), and D141's stop is not changed for a game's first seconds. My reading of one sentence; nothing shipped is removed by it |
|
||||
| D154 | [`18_GPU_VENDOR_APIS.md`](18_GPU_VENDOR_APIS.md) §The trains, [`20_OPEN_QUESTIONS.md`](20_OPEN_QUESTIONS.md) §M15 | Advanced metrics is closed: train D is not built, the ten Streamline entries that waited for a spike are not read (`RefusedRoute`), rule 4 is not amended for them. Nothing shipped is removed |
|
||||
| D155 | [`21_INPUT_DEVICES.md`](21_INPUT_DEVICES.md) §The owner's request and decisions | controllers are read by the Agent, from outside the game: no hook is added, rule 4 is untouched, and a session that is not hooked has the numbers too |
|
||||
| D156 | [`21_INPUT_DEVICES.md`](21_INPUT_DEVICES.md) §The owner's request and decisions | the reading is on unless switched off (`capture.input_devices`), and reads nothing until the Privacy Policy that describes it (2.22 or later) has been accepted on the PC |
|
||||
| D157 | [`21_INPUT_DEVICES.md`](21_INPUT_DEVICES.md) §The owner's request and decisions | built without a probe run on real controllers first ("Xây thẳng"): every source reports what it did, and what was verified against hand-made data only is said in each pull request |
|
||||
| D158 | [`21_INPUT_DEVICES.md`](21_INPUT_DEVICES.md) §The owner's request and decisions | keyboard and mouse are one class known only by `GetLastInputInfo`'s time: no Raw Input for them, no hook, no key in the process |
|
||||
| D159 | [`21_INPUT_DEVICES.md`](21_INPUT_DEVICES.md) §DualSense | nothing is ever sent to a controller; a DualSense on Bluetooth has a battery level only where Steam or the game switched it |
|
||||
| D160 | [`21_INPUT_DEVICES.md`](21_INPUT_DEVICES.md) §The owner's request and decisions | the numbers are columns of `sessions`, so they are in the CSV/JSON export and in a bug bundle, and the Privacy Policy's §3A says so |
|
||||
| D161 | [`21_INPUT_DEVICES.md`](21_INPUT_DEVICES.md) §The owner's request and decisions | a session that is not hooked is duration, hardware telemetry, the reason — and what the Agent reads from outside the game; CLAUDE.md's sentence is amended with the pull request that makes it true |
|
||||
| D162 | [`03_METRICS.md`](03_METRICS.md) §Input | also built: switches of method and the share with no input, marks on the frame-time chart, a battery's first and last level and its rate, the kind of connection, the Steam Input note, a trend metric, a Compare row, "usually played with" |
|
||||
| D163 | [`21_INPUT_DEVICES.md`](21_INPUT_DEVICES.md) §The owner's request and decisions | "supports controllers" is three pieces of evidence and never a verdict: Steam's own file on the disk (no network), the input libraries the game loaded, how the game was played |
|
||||
| D109 | [`../legal/DISCLAIMER.md`](../legal/DISCLAIMER.md) §5, §5A | asked on 2026-11-11 with both sentences quoted: the Disclaimer goes to 2.15 with the Privacy Policy — PawnIO and the admin mode are no longer "for the CPU temperature" alone; with Advanced metrics on they also read the processor's, the memory's and the motherboard's sensors. The admin mode's disclosure follows (`agent-admin-dialog/2`) |
|
||||
|
||||
---
|
||||
|
||||
@@ -69,6 +69,7 @@ are safety items, and something listed there as unresolved should not be built t
|
||||
| [`18_GPU_VENDOR_APIS.md`](18_GPU_VENDOR_APIS.md) | Telemetry layers (DXGI/PDH, LibreHardwareMonitor, NVAPI), the game process's memory, licences |
|
||||
| [`19_SAFETY_AND_ANTICHEAT.md`](19_SAFETY_AND_ANTICHEAT.md) | The anti-cheat guard, what a finding does, the user-mode exception, what will never be built |
|
||||
| [`20_OPEN_QUESTIONS.md`](20_OPEN_QUESTIONS.md) | Every unresolved question, defect and measurement, with its status marker |
|
||||
| [`21_INPUT_DEVICES.md`](21_INPUT_DEVICES.md) | Controllers and keyboard-and-mouse activity: what is read from outside the game, from where, and what never is |
|
||||
| [`HANDOFF.md`](HANDOFF.md) | Sequencing, the open owner-only items, the index of the owner's decisions |
|
||||
| [`handoff/`](handoff/) | Since beta.24 (D66): the history of every train and phase, the passed owner-only items, the traps — moved out of `HANDOFF.md` verbatim |
|
||||
| [`open-questions/`](open-questions/) | Since beta.24 (D66): the entries §S24 marks resolved, moved out of `20_OPEN_QUESTIONS.md` verbatim — a table there lists them |
|
||||
|
||||
@@ -0,0 +1,42 @@
|
||||
<!-- Moved from CHANGELOG.md's [Unreleased] when 0.1.0-beta.46 was cut, 2026-11-13 (D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.46] - 2026-11-13
|
||||
|
||||
**The forty-sixth pre-release: hooks go into a game together, and come out together.** Putting a hook in or taking
|
||||
it out stops every thread of the game for a moment. Until now that happened once for every hook: in the first real
|
||||
sessions on 0.1.0-beta.45 the thirteen NVIDIA Streamline hooks took between 0.7 and 2.8 seconds of a game's start,
|
||||
and stopping a session took about a sixth of a second for each hook. The hooks FrameLedger finds something for at
|
||||
one moment are now put in under **one** stop of the game's threads, and a stop takes all of them out under one.
|
||||
This release is that change and nothing else in the part that runs inside a game; the pages are also brought up to
|
||||
date with what those first sessions showed. The same unsigned installer: verify its hash against `SHA256SUMS.txt`,
|
||||
then *More info → Run anyway*.
|
||||
|
||||
**What it is not, yet.** It has **not been run in a real game**. On FrameLedger's own test program nine hooks go
|
||||
in within 78–90 thousandths of a second where they took 0.6–0.7 seconds, and eighteen come out within 76–90 where
|
||||
they took 1.4–1.6 seconds; how long one stop of the threads is in a game with a few hundred of them, and whether
|
||||
any game minds its hooks arriving together, are for the first real sessions to say. Nothing new is read and
|
||||
nothing a hook reads has changed, so the terms are the ones you accepted. Of 0.1.0-beta.45's six new readings five
|
||||
have now been read in real games; no game run so far set up a feature's resources after FrameLedger was in it, so
|
||||
that row has not been seen. Everything 0.1.0-beta.45's notes say is not yet done still stands.
|
||||
|
||||
**Updating from `0.1.0-beta.45`:** Help ▸ Check for updates, then *Restart to update* with no game running. **The
|
||||
terms are not shown again** (Privacy Policy 2.19 as before). No change to the ledger (schema 23), the detection
|
||||
rules stay at `2026.11.2`. **The code loaded into a game changed in this release**, so a game that was running
|
||||
during the update keeps the old part until it is started again.
|
||||
|
||||
### Changed
|
||||
|
||||
- **Hooks go into a game together, and come out together** (owner decision D134). Putting a hook in or taking it
|
||||
out stops every thread of the game for a moment, and until now that happened once for every hook: the thirteen
|
||||
Streamline hooks took 0.7 to 2.8 seconds of a game's start in real sessions (2026-11-13), and stopping a session
|
||||
took about a sixth of a second for each hook — two to three seconds, sometimes on the thread that draws. The
|
||||
hooks a moment finds are now put in under **one** stop of the threads, and a stop takes all of them out under
|
||||
one. On FrameLedger's own test program: nine hooks in 78–90 ms where they took 0.6–0.7 s; eighteen out in
|
||||
76–90 ms where they took 1.4–1.6 s. What a hook reads and when it is installed are unchanged, and no hook's own
|
||||
code changed. The log of the part inside the game has a new line for each such moment (`PATCH_BATCH`, with the
|
||||
time it took and the number of hooks). **Not run in a real game yet.**
|
||||
|
||||
- **The limitations, the accuracy statement and the user guide say what the first real sessions on 0.1.0-beta.45
|
||||
showed** (2026-11-13, six games): five of its six new readings were read in real games — every Streamline game
|
||||
asked whether its features are supported — and no game allocated a feature's resources after FrameLedger was in
|
||||
it, so that row has not been seen. No code changes.
|
||||
@@ -0,0 +1,92 @@
|
||||
<!-- Moved from CHANGELOG.md's [Unreleased] when 0.1.0-beta.47 was cut, 2026-11-14 (D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.47] - 2026-11-14
|
||||
|
||||
**The forty-seventh pre-release: with Advanced metrics on, FrameLedger reads NVIDIA's own report of where a frame's
|
||||
time goes.** On an NVIDIA card, in a Direct3D 12 game that uses NVIDIA Reflex, a session recorded with *Advanced
|
||||
metrics* on now also stores how long the graphics driver says each stage of a frame took — simulation, render
|
||||
submit, present, driver, the operating system's queue, the graphics card — as seven lines under *Latency* on the
|
||||
Advanced page, with a table of the driver's low-latency state. **They are the driver's numbers, not a measurement
|
||||
by FrameLedger**, and they are not the delay from a click to the screen. The same unsigned installer: verify its
|
||||
hash against `SHA256SUMS.txt`, then *More info → Run anyway*.
|
||||
|
||||
**This is the first release in which the part inside a game makes a call of its own.** Until now it only read what
|
||||
a game itself passed to the graphics calls FrameLedger intercepts. To read this report it asks the graphics driver,
|
||||
about once a second, on the game's own thread that presents its frames — two functions of the driver that only
|
||||
read. It reaches them through NVIDIA's library only where the game had already loaded it, and never loads that
|
||||
library itself; a copy sitting in the game's own folder is not the driver's and is not used. It is built to step
|
||||
back rather than disturb a game: a request that takes two thousandths of a second or more, or that goes wrong, is
|
||||
the last one until the game is closed, and the session says so. **With Advanced metrics off — the default — none
|
||||
of this happens.** The Disclaimer and the Privacy Policy say all of it; the terms window shows once.
|
||||
|
||||
**What it is not, yet.** **No real game has been read.** The reading was written and tested against FrameLedger's
|
||||
own test program with a stand-in for NVIDIA's library, and measured with a test tool against one driver on one
|
||||
card (GeForce RTX 5080, driver 32.0.16.2114): there a request takes about three millionths of a second, and none
|
||||
took a thousandth while the tool, like a game using Reflex, slept between frames. What a game's own threads, frame
|
||||
generation, another driver or another card do with it is for the first real sessions to say; a game that enforces
|
||||
Windows' Control Flow Guard on a driver that tool was not run against is not covered. On a busy PC the
|
||||
two-thousandths limit will now and then switch the reading off for a pause that was Windows' and not the driver's;
|
||||
the session then says *stopped* with the time, and the next start of the game reads again. The session summary's
|
||||
latency fields still read N/A, and nothing here is read on Direct3D 11, Vulkan or OpenGL. No test runs the whole
|
||||
path from the game to the ledger through the real capture agent; the Japanese texts are new and unreviewed.
|
||||
|
||||
**Also in this release.** The log of the part inside a game now says how a group of hooks went in or came out —
|
||||
in one go, or one hook at a time — after two groups in the first real sessions on 0.1.0-beta.46 took far longer than
|
||||
the rest and the log could not say why. And 0.1.0-beta.46's other half has now been seen in a real game: stopping
|
||||
the part inside a running game took all twenty-nine hooks out under one stop of 83–86 thousandths of a second,
|
||||
twice, and the game went on.
|
||||
|
||||
**Measured overhead this release.** A presented frame: one more read of one word; too small to measure on the
|
||||
test program. The request to the driver, once a second while Advanced metrics is on: 2.5–2.6 millionths of a second
|
||||
at the median after a frame that slept, 8–67 at worst, in three runs alone; 3.4 and 130 on a busy PC. Not measured
|
||||
in a game.
|
||||
|
||||
**Updating from `0.1.0-beta.46`:** Help ▸ Check for updates, then *Restart to update* with no game running. **The
|
||||
terms are shown once** — Privacy Policy 2.20 and Disclaimer 2.16. No change to the ledger (schema 23) or to the
|
||||
shared memory's layout (5); the detection rules stay at `2026.11.2`. **The code loaded into a game changed in this
|
||||
release**, so a game that was running during the update keeps the old part until it is started again.
|
||||
|
||||
### Changed
|
||||
|
||||
- **The log of the part inside a game says how a group of hooks went in or came out** (owner decision D137). Since
|
||||
0.1.0-beta.46 hooks are put into a game in groups, the game's threads stopped once for a group. In the owner's
|
||||
first sessions two groups took much longer than the others (0.6 s and 1.3 s against 0.1-0.3 s), and the log
|
||||
could not tell one long stop from a group that had to be finished one hook at a time. The `PATCH_BATCH` line now
|
||||
reads `install` or `restore` for a group that went in one go, and `install singly` or `restore singly`, with a
|
||||
count, for one that did not. Nothing else about hooking changed, and what a game is measured by is the same.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **For developers: a native test that is cut short no longer counts as passed.** The quality gate's native tests
|
||||
were judged by their exit code alone, and a test program that was stopped early with a clean exit code read as
|
||||
*Passed* - seen once, when security software removed the test program while the gate ran. Every native test now
|
||||
has to print the line it ends on, a test added without one stops the build's configure step, and four tests
|
||||
exist only to prove the rule goes red when it should. Nothing a user installs changed.
|
||||
|
||||
### Added
|
||||
|
||||
- **The part inside a game can read NVIDIA's own latency report, with Advanced metrics on** (owner decisions D132, D136,
|
||||
D138-D141). While a session records Advanced metrics, and only then, it asks the graphics driver about once a
|
||||
second for its report of a frame's stages - simulation, render submit, present, driver, the operating system's
|
||||
queue, the graphics card - and for its low-latency state. It is a call FrameLedger makes itself, on the thread
|
||||
that presents the game's frames, through NVIDIA's `nvapi64.dll` only where the game had already loaded it;
|
||||
Direct3D 12 only. A copy of that library sitting in the game's own folder is refused. A call that faults or takes
|
||||
two milliseconds is the last one until the game is closed. **The Advanced page shows it** under *Latency*: seven
|
||||
lines, one a stage, and a table of the driver's low-latency state; the line under a session says what became of
|
||||
the read - read, the driver reported no frame, not read and why, or stopped and why. They are the driver's
|
||||
numbers, not a measurement by FrameLedger, and no real game had been read when this was written. **Privacy
|
||||
Policy 2.20 and Disclaimer 2.16** say what is stored and what the part inside a game now does; the terms window
|
||||
will show once.
|
||||
|
||||
- **For developers: room in the shared memory for NVIDIA Reflex latency** (owner decisions D136, D138). Ten reserved
|
||||
words of the block that carries Advanced metrics from a game are now named for the driver's latency report -
|
||||
where the read stands, and a sum for each stage of a frame. Nothing writes them yet and nothing reads them; the
|
||||
shared memory's layout version did not change.
|
||||
|
||||
- **For developers, nothing a user installs: a probe for NVIDIA Reflex latency** (owner decision D132). An
|
||||
unshipped tool, `fl-probe-reflex`, and a stand-in `nvapi64.dll` among the test fixtures measure what it would take
|
||||
to read the driver's latency report from inside a game - on FrameLedger's own test program and against the
|
||||
installed driver, never in a game. What it found is `docs/spike-notes/31-reflex-route-d-harness.md`. A further
|
||||
leg (owner decision D139) measured the same reads while the probe itself used Reflex's sleep, as a game does:
|
||||
the reads do not wait behind it. The owner has said to go on to a real game (D136); that work is not in any
|
||||
release yet. Nothing in the App, the Agent or the part that runs inside a game changed.
|
||||
@@ -0,0 +1,90 @@
|
||||
<!-- Moved from CHANGELOG.md's [Unreleased] when 0.1.0-beta.48 was cut, 2026-11-14 (D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.48] - 2026-11-14
|
||||
|
||||
**The forty-eighth pre-release: NVIDIA's latency report has now been read in real games, and what they showed is
|
||||
in it.** On the day 0.1.0-beta.47 came out the owner recorded eight sessions with *Advanced metrics* on. The
|
||||
report was read in Phantom Blade Zero and in Cyberpunk 2077, with frame generation on and off: the driver answered
|
||||
every second, the slowest request took 65 millionths of a second, nothing was switched off, and no game was
|
||||
disturbed that the logs can show. Two games that are not Direct3D 12 and one that never loaded NVIDIA's library
|
||||
were left alone, each with its one line saying why. The same unsigned installer: verify its hash against
|
||||
`SHA256SUMS.txt`, then *More info → Run anyway*.
|
||||
|
||||
**What the first game showed, and what this release does about it.** In Phantom Blade Zero the line called *GPU
|
||||
render* was longer than the whole frame — 16 thousandths of a second where the total was 5. That line runs from
|
||||
the moment the graphics card starts on a frame to the moment it ends, **and includes the time the card waited in
|
||||
between**. NVIDIA's driver also works out the figure without the waiting, and the time from one frame's end to the
|
||||
next. Both are in the report FrameLedger already asks for, and a session now stores them as **a second chart under
|
||||
*Latency*, with two lines**: *GPU active render* and *GPU frame time*. Nothing more is asked of the driver. The
|
||||
old line stays, under a name that says what it includes. **The stages of a frame overlap; they were never parts
|
||||
that add up to the total**, and the texts now say so.
|
||||
|
||||
**Three more things the sessions showed.**
|
||||
- The table of the driver's low-latency state kept only the *last* frame-generation multiplier: a session that
|
||||
generated frames at ×2 and ended in a menu showed 1. It now lists every value the session saw — *1, 2*.
|
||||
- **Sensors were read every 1.3 seconds where the setting says every second** — on the owner's PC, in nearly every
|
||||
session since the series began. The capture agent waited the whole interval *after* each reading, and a reading
|
||||
there takes about a third of a second. It now keeps the period. No chart was wrong, because every sample is
|
||||
stored with its own time; but a session now has about a third more samples, and readings of the latency report
|
||||
no longer fall between two of them. What makes a reading take that long there is not established.
|
||||
- A session could begin with the last reading of the session before it, in a game that kept running between the
|
||||
two. It no longer does.
|
||||
|
||||
**What it is not.** Two games on one driver and one card (GeForce RTX 5080, driver 32.0.16.2114) are not every
|
||||
game. The two new figures have not been seen from a real game yet: a driver may give neither, and the chart is
|
||||
then simply not there. Reflex switched off in a game's menu, and a game started with Advanced metrics off, have
|
||||
still not been tried on a real game. They remain the driver's numbers, not a measurement by FrameLedger, and not
|
||||
the delay from a click to the screen; the session summary's latency fields still read N/A. Nothing here is read
|
||||
on Direct3D 11, Vulkan or OpenGL. The Japanese texts are new and unreviewed.
|
||||
|
||||
**Measured overhead this release.** A presented frame: unchanged. The request to the driver, once a second while
|
||||
Advanced metrics is on: summing the two further figures adds about 36 billionths of a second to work that follows
|
||||
the request itself. In the real games of 2026-11-14 the slowest request took 20 to 65 millionths of a second.
|
||||
|
||||
**Updating from `0.1.0-beta.47`:** Help ▸ Check for updates, then *Restart to update* with no game running. **The
|
||||
terms are shown once** — Privacy Policy 2.21 and Disclaimer 2.17. No change to the ledger (schema 23) or to the
|
||||
shared memory's layout (5); the detection rules stay at `2026.11.2`. **The code loaded into a game changed in this
|
||||
release**, so a game that was running during the update keeps the old part until it is started again.
|
||||
|
||||
### Added
|
||||
|
||||
- **Two more lines from NVIDIA's latency report: how long the graphics card was really at work** (owner decision
|
||||
D142). In a real game the driver's *GPU render* stage turned out longer than the whole frame: it runs from the
|
||||
card's start to its end and includes the time the card waited. With Advanced metrics on, a session now also
|
||||
stores two figures the driver works out itself — **GPU active render**, the same stage without the waiting, and
|
||||
**GPU frame time**, from the end of one frame's work to the end of the next — as a second chart under *Latency*.
|
||||
They come from the report FrameLedger already asks the driver for; nothing more is asked. A driver may give
|
||||
neither, and the chart is then not there. Sessions recorded before this release do not have them.
|
||||
|
||||
- **For developers: the part inside a game reads two more figures of NVIDIA's latency report, and keeps every
|
||||
frame-generation multiplier a session saw** (owner decisions D142, D144). In a real game the driver's span between its two GPU marks was longer than the frame's whole
|
||||
— it includes the card's waiting. The driver's own *active* render time and its GPU frame time are members of
|
||||
the report FrameLedger already fetches; they are read from it, with **no further call into the driver**. Four
|
||||
reserved words of the shared memory carry them and the multipliers seen (layout 5 as it was). `fl_reflex_summary`
|
||||
and the injected `[latency]` cases hold it. Measured: +36 ns a read, once a second.
|
||||
|
||||
### Changed
|
||||
|
||||
- **The *GPU render* line says what it includes** (owner decision D143): *GPU render, start to end (idle time
|
||||
included)*, in the three languages. The numbers are the same.
|
||||
- **The driver's frame-generation multiplier is every value the session saw** (owner decision D144). The table of
|
||||
the driver's low-latency state kept only the last one: a session that generated frames at ×2 and ended in a menu
|
||||
showed 1. It now shows *1, 2*. Sessions already recorded keep what they stored.
|
||||
- **The texts say what was read** (owner decision D145). The accuracy statement, the README and the guide said no
|
||||
real game had been read; two have been, on one driver. They also say now that the stages overlap and do not add
|
||||
up to the total. **Privacy Policy 2.21** names the two new averages; **Disclaimer 2.17** changes only with the
|
||||
accuracy statement it carries. The terms window shows once.
|
||||
|
||||
### Fixed
|
||||
|
||||
- **Sensors were read less often than the setting says** (owner decision D146). With the sensor interval at
|
||||
1000 ms, nearly every session on the owner's PC got a sample every 1.3 seconds: the Agent waited the whole
|
||||
interval *after* each reading, and a reading there takes about a third of a second (what in it does is not
|
||||
established; on a PC where the Agent is not run as administrator it takes a millisecond, and the samples were
|
||||
already a second apart). It now keeps the period. No chart was wrong — every sample is stored with its own time — but a session
|
||||
has about a third more samples now, and about a quarter of the readings of NVIDIA's latency report no longer
|
||||
fall between two samples. For developers: `sensor_blobs.hz` was the constant 1 and is now the rate the
|
||||
session's samples had.
|
||||
- **A session could start with the last read of the session before it.** In a game that kept running between two
|
||||
sessions, a read of the driver's latency report that ended after the first session's last tick was taken as the
|
||||
second session's first point. A new session now drops it.
|
||||
@@ -0,0 +1,79 @@
|
||||
<!-- Moved from CHANGELOG.md's [Unreleased] when 0.1.0-beta.49 was cut, 2026-11-14 (D66). CHANGELOG.md lists every release. -->
|
||||
|
||||
## [0.1.0-beta.49] - 2026-11-14
|
||||
|
||||
**The forty-ninth pre-release: what the owner's sessions on 0.1.0-beta.48 showed, the same day.** Eighteen
|
||||
sessions, sixteen of them with *Advanced metrics* on — Phantom Blade Zero, Cyberpunk 2077 and Clair Obscur:
|
||||
Expedition 33, with frame generation on and off, with Reflex on and off. Sensors are now read every second; NVIDIA's driver gave both
|
||||
of its own GPU times in every report of every game; the table lists every frame-generation multiplier; a game
|
||||
started with the option off was left alone; the driver was read just the same with Reflex off; and the owner's
|
||||
word on how the games felt: no hitch. The same unsigned installer: verify its hash against `SHA256SUMS.txt`, then
|
||||
*More info → Run anyway*. **No legal text changed, so the terms window does not appear.**
|
||||
|
||||
**Two things those sessions showed, and what this release does about each.**
|
||||
- **The *Latency* charts had holes.** After a session's first reading, between 0.4 and 16 % of its samples had
|
||||
none. There were two reasons, one on each side. The part inside the game did its once-a-second round a second
|
||||
*after* the last one finished — so it fell behind — and whenever the game loaded a library it was woken early,
|
||||
published what it had, and asked the driver for nothing new. And the capture agent kept one reading until a
|
||||
sample could carry it, and replaced it if another arrived first. Both are mended: the round inside the game is
|
||||
now due at fixed moments, and the agent keeps the reading that waits.
|
||||
- **In Cyberpunk 2077 without frame generation, NVIDIA's *GPU active render* time is longer than the time from the
|
||||
card's start on a frame to its end** — which should contain it. Nothing stored can say whether that is the
|
||||
driver's arithmetic or the way FrameLedger averages the two (one over every frame, one only over the frames that
|
||||
gave a time). **This release changes no number you see.** It counts, frame by frame, how the two stand to each
|
||||
other, and writes the counts to the game component's own log, together with the driver's low-latency state and
|
||||
its frame-generation multiplier — the owner asked that Reflex and frame generation always be read together. The
|
||||
next sessions say which it is; what to do about it is decided then.
|
||||
|
||||
**What it is not.** Not a promise that every sample now carries a reading: with both sides on one second a slip
|
||||
can still leave one without, and the log says how often. The reason given for the agent's half was read from the
|
||||
code and fits the pattern in the ledger; it has not been measured in a session. Nothing here is read on
|
||||
Direct3D 11, Vulkan or OpenGL, and the figures remain the driver's, not a measurement by FrameLedger. The log of
|
||||
the component inside a game grows by about seven lines a minute while *Advanced metrics* reads the driver — a few
|
||||
tens of kilobytes an hour — and a bug report carries those logs, as it always carried them. A game that closes by
|
||||
itself loses the last batch of counts, under a minute.
|
||||
|
||||
**Measured overhead this release.** A presented frame: unchanged — no line that runs with a present was touched.
|
||||
The reading of the driver's report, once a second while a session with *Advanced metrics* runs in a Direct3D 12
|
||||
game: 65 billionths of a second more (424–435 → 490–499 billionths, the same instrument as before), after the
|
||||
request's own time has been taken. The background thread inside the game: ten readings in 9 996 ms, twenty in
|
||||
20 002, sixty in 59 997 on the test harness — and the same with another thread waking it eighteen thousand times
|
||||
in ten seconds, where the code before it published 35 720 times in eight seconds and read nine times.
|
||||
|
||||
### Added
|
||||
|
||||
- **The frames NVIDIA's latency report gives are counted, for the Overlay's own log** (owner decisions D148,
|
||||
D151; nothing new is stored, shown, asked of the driver or read from its report). The owner's sessions on
|
||||
0.1.0-beta.48 showed both of the driver's own GPU times in two games — and in Cyberpunk 2077 without frame
|
||||
generation an *active render* time longer than the span from the card's start on a frame to its end, which the
|
||||
two averages cannot explain: one is over every frame, one only over the frames that gave a time. While a session
|
||||
with *Advanced metrics* reads the driver, the Overlay now places each frame by its own two numbers and writes
|
||||
the counts to `overlay-<pid>-….log` as `LATENCY_FRAMES` lines, in batches that each belong to **one state of
|
||||
the driver's low-latency status and its frame-generation multiplier** — the counts are read together with
|
||||
Reflex and frame generation, never apart. About six lines a minute; a game that exits by itself loses the last
|
||||
batch, under a minute. A bug report carries those logs, as it carried them before. Measured: 65 billionths of a
|
||||
second more for each reading of the report, once a second; a presented frame costs what it did.
|
||||
|
||||
### Changed
|
||||
|
||||
- **The guide says whose switches the latency table shows**: the driver's, not the game's menu. `bLowLatencyMode`
|
||||
is also on when *Low Latency Mode* is set for the game in the NVIDIA App, and `bUseGameSleep` says whether the
|
||||
game itself paces its frames through Reflex — in some games only with frame generation on (the owner's word,
|
||||
2026-11-14, and what Clair Obscur's sessions of that afternoon read).
|
||||
|
||||
### Fixed
|
||||
|
||||
- **NVIDIA's latency report is read on a grid of one second, and a busy loader no longer leaves holes in it**
|
||||
(owner decision D150; the Overlay's half). After a session's first report, 0.4 to 16 % of its samples carried
|
||||
none — the *Latency* charts had gaps. The Overlay's background thread waited a second *after* each round of its
|
||||
work, so it fell behind the capture agent, which samples exactly every second; and whenever the game loaded a
|
||||
library that thread was woken early, published what it had and asked for no new reading, so the round after it
|
||||
had nothing to publish. Its once-a-second round is now due at fixed moments whatever the work took, and a round
|
||||
woken early no longer publishes or takes a reading. Two readings are never less than half a second apart.
|
||||
Nothing on a game's own threads changed.
|
||||
- **A reading that waits for a sample is no longer overwritten by the next one** (D150; the capture agent's
|
||||
half). The agent kept one reading from the game until a sensor sample could carry it, and replaced it when
|
||||
another arrived first. When a reading landed just after a sample, that sample went without and a reading was
|
||||
lost a little later — in one session of the owner's, one sample in five for four minutes. Two readings may now
|
||||
wait and the older is stored first; a point can stand up to a second after its reading was taken. With the
|
||||
sensor interval above one second, not every reading is stored, as before.
|
||||
@@ -0,0 +1,175 @@
|
||||
# HANDOFF history — 0.1.0-beta.45
|
||||
|
||||
*Moved verbatim from `docs/HANDOFF.md` when 0.1.0-beta.46 was cut, 2026-11-13 (owner decision D66); `docs/HANDOFF.md` §How this file is split lists every part. Nothing below was edited, so its "below" and "above" mean HANDOFF.md as it stood then, and a path it writes is relative to `docs/`. **Its §NEXT says 0.1.0-beta.46 is to come**: it was released the next day, and what it built and decided is HANDOFF.md's section for it.*
|
||||
|
||||
## **START HERE** — 2026-11-12, 0.1.0-beta.45: six more of Streamline's calls, hooked only where asked; `slInit` stays out; the Reflex spike as a document
|
||||
|
||||
*Status is `docs/changelog/0.1.0-beta.45.md`; this is what no other file carries.* The owner ran eight sessions on
|
||||
beta.44 the evening it was released and said: add the three new ones, update, go on. They were read from a copy of
|
||||
the ledger and the logs (#426); asked to reopen D112, the owner was shown why `slInit` cannot be seen and chose to
|
||||
leave it out (D129), chose six other calls for one release (D130), and approved the plan with Privacy Policy 2.19's
|
||||
wording. Four pull requests and this one: #427 (`slIsFeatureSupported`, `slIsFeatureLoaded`, `slSetFeatureLoaded`
|
||||
in the Overlay; D129–D131), #428 (`slAllocateResources`, `slFreeResources`, `slShutdown`), #429 (the Agent, the
|
||||
App, Privacy Policy 2.19), #430 (train C's spike, a document: `spike-notes` §30). **What the eight sessions on
|
||||
beta.44 showed, session by session, is [`handoff/history/0.1.0-beta.44.md`](handoff/history/0.1.0-beta.44.md)**;
|
||||
what each pull request built is [`17_HOOK_ENGINE.md`](17_HOOK_ENGINE.md) §Hook inventory (the two rows of the six
|
||||
calls, with their measured cost) and [`18_GPU_VENDOR_APIS.md`](18_GPU_VENDOR_APIS.md) §Train B (the fourth step).
|
||||
|
||||
### What this release decided, beyond D129–D131
|
||||
|
||||
- **Everything the six calls give is word 1 of a feature's slot, and one reserved word.** Bits 2–4 the two answers
|
||||
(supported, with the `sl::Result` in bits 8..15; loaded and its value), bits 5–6 the game switching the feature
|
||||
off and on, bits 16..19 and 20..23 two counts that stop at fifteen and never carry; `slShutdowns` took the first
|
||||
of three reserved words (@308). Layout 5 and schema 23 as they were. **The answers are the process's and a new
|
||||
request keeps them; the switching, the counts and the shutdowns are a session's and a new request clears them.**
|
||||
- **A refusal is the answer.** `slIsFeatureSupported`'s detour calls the original first and keeps whatever it
|
||||
returned; the page names it by NVIDIA's enumerator (forty codes, the same order at sixteen upstream tags from
|
||||
v2.0.0 to v2.14.16), `result <n>` past the list, 255 for a code a byte could not carry.
|
||||
- **The two calls on a game's way out note the call, then call the original, and run nothing after it** —
|
||||
`slFreeResources` and `slShutdown`. The fixture shuts Streamline down and goes on using the stub through every
|
||||
detour.
|
||||
- **The adapter is never read** (D131), and the build refuses the names of `sl::AdapterInfo`'s members in the code
|
||||
loaded into a game (`overlay-fields-check`); the fixture hands a wild LUID pointer.
|
||||
- **A stop restores its patches one after another, about 160 ms each.** MinHook stops every thread of the process
|
||||
for each `MH_DisableHook`. With six more patches the stop's last log lines were cut at the two seconds the
|
||||
Overlay waited for them; the wait is now sized to the patch table (`250 ms × kMaxPatches`). The patches were
|
||||
always restored; `UNHOOKED` is written after the last. **Not changed, and proposed**: queueing the restores (and
|
||||
the installs) so the threads are stopped once — a change to the hook engine's order of operations, which wants
|
||||
its own pull request, its own measurement and the owner's word. Until then a stop in a Streamline game with
|
||||
Advanced metrics on takes two to three seconds on the thread that stops.
|
||||
- **Six calls are one sentence on the page**, each by its function's name under which of three things became of
|
||||
it; a row stored before this release has none of the six and no such sentence.
|
||||
- **`AdvancedReach.BeforeAttach` is a reason of its own** for `sl.init.preferences`: not "a later release". No
|
||||
catalog entry carries `NewHook` any more; the value stays, for rows a later train may add.
|
||||
- **Where the rows sit in the table** (rows are patched in its order): the two questions after beta.44's two, at
|
||||
the head; `slSetFeatureLoaded` after `slSetConstants`; the three counted calls last of the Streamline block.
|
||||
- **Train C's spike is a reading** (`spike-notes` §30): hooking NVAPI's or Streamline's latency functions is
|
||||
refused or is train D's wrapper; the Overlay calling `slReflexGetState` breaks the vendor's thread contract;
|
||||
what remains is the Overlay calling two driver getters with the game's device, and a no-injection ETW route
|
||||
that gives half the number. It ends in three questions that are the owner's.
|
||||
|
||||
### Traps this train left
|
||||
|
||||
- **The catalog table of `18_GPU_VENDOR_APIS` is compared with the catalog row for row by a test**: a catalog
|
||||
entry and its row go in the same commit, or the Application tests are red.
|
||||
- **Qodana's native report again found an index into the feature slots computed as a 32-bit product** (#427, the
|
||||
harness's probe): write `size_t{2} * FL_ADV_FEATURE_WORDS`. It is advisory and auto-merge does not wait for it;
|
||||
both reports were read before each merge.
|
||||
- **A second `region` inside the probe's block is C4456**, and warnings are errors: name the inner one otherwise.
|
||||
- **A test method over sixty lines is MA0051** in the test projects too; split the assertions by what they cover.
|
||||
- **The injected test waits for the stop**: with eighteen patches a stop takes about three seconds, so its wait is
|
||||
200 iterations.
|
||||
- **The shell tool refuses `sleep N; command`**: wait in a background `until` loop.
|
||||
- **After a lower pull request is squashed**, `git diff <old tip> origin/main` empty proves the squash is the
|
||||
branch; then `git rebase --onto origin/main <old tip> <next branch>` and a forced push with lease.
|
||||
|
||||
### What the owner's seven sessions on beta.45 showed (2026-11-13)
|
||||
|
||||
The owner ran seven sessions on six games the day after the release and said: check the logs and go on. Read from
|
||||
a copy of the ledger (sessions 190–196), the seven overlay logs, the Agent's log and Windows' application log —
|
||||
no FrameLedger binary was run against the owner's data. **Every session is hooked, `normal`, with no fault
|
||||
counted, no dropped record and no `PATCH_FAILED`; the count of early ends is 0 on all six games.** The update
|
||||
showed the terms once: Privacy Policy 2.19 was accepted at 07:23:36.
|
||||
|
||||
| Game (session, length) | Interposer | `slIsFeatureSupported` | `slIsFeatureLoaded` | `slSetFeatureLoaded` | allocate | free | shutdown |
|
||||
|---|---|---|---|---|---|---|---|
|
||||
| Phantom Blade Zero (190, 2 h 48 min; 191, 1 h 32 min) | 2.14.1 | **read** — Reflex, DLSS frame generation, PCL `eOk`; ImGUI and DeepDVC `eErrorFeatureMissing` | **read** — Reflex, frame generation *on* | not called | not called | **read** — frame generation, 1 | not called |
|
||||
| Cyberpunk 2077 (193, 7 min) | 2.14.1 | **read** — frame generation, DLSS, ray reconstruction, Reflex `eOk`; NIS `eErrorFeatureMissing` | **read** — the four *on* | **read** — the four, *on and off* | not called | not called | not called |
|
||||
| Dying Light: The Beast (194, 4 min) | 2.8.0 | **read** — DLSS, frame generation, PCL, Reflex, NIS `eOk` | not called | **read** — all five, *on and off* | not called | not called | **read** — 1 |
|
||||
| Hogwarts Legacy (195, 4 min) | 2.14.16 | **read** — frame generation, Reflex, DeepDVC, DLSS 5's `kFeatureDLSS_NR`, PCL `eOk`; ImGUI `eErrorFeatureMissing` | **read** — the first four *on* | not called | not called | not called | not called |
|
||||
| Black Myth: Wukong (196, 3 min) | 2.7.4 | **read** — frame generation, Reflex, PCL `eOk` | not called | not called | not called | not called | not called |
|
||||
| Kingdom Come: Deliverance II (192, 4 min) | none | not hooked | not hooked | not hooked | not hooked | not hooked | not hooked |
|
||||
|
||||
- **`slIsFeatureSupported` was read in every Streamline session, and `slAllocateResources` in none.** Item 43
|
||||
wrote the meaning of that before the run: a call no game makes after the attach gives nothing in attach mode, and
|
||||
whether it keeps its patch is the owner's to say. `slFreeResources` and `slShutdown` were each read once, in one
|
||||
game each; `slIsFeatureLoaded` in three games, `slSetFeatureLoaded` in two.
|
||||
- **A refusal reads as one.** Phantom Blade Zero and Hogwarts Legacy ask about `kFeatureImGUI`, Streamline's
|
||||
debug overlay, and are told it is missing; Cyberpunk 2077 is told the same of NIS, which Dying Light is told is
|
||||
supported. Phantom Blade Zero is told DeepDVC is missing although Streamline answered its requirements.
|
||||
- **The count says how often, not when.** Dying Light's one shutdown and Phantom Blade Zero's one freeing of frame
|
||||
generation's resources may each be the game closing; nothing in a session says. Dying Light switched all five
|
||||
features off and on.
|
||||
- **The way out is as it was.** Hogwarts Legacy faulted at its exit in `_nvngx.dll`, `0xc0000005` at offset
|
||||
`0x6aa85` — the offset of its six before, since 2026-11-06, hooked or not — and Black Myth: Wukong in
|
||||
Steam's `crashhandler64.dll`, `0xc0000409` at `0x39b49`, the offset of its three before (Steam's file is now
|
||||
11.23.65.88). Windows' log has no fault for the other four games; the two hooks on a game's way out were in all
|
||||
five Streamline games.
|
||||
- **Rates are where they were**, for what a comparison without the same scene is worth: Phantom Blade Zero ×4 at
|
||||
64 → 255 (beta.44: 63 → 251), Wukong 85 → 341 (90 → 361), Cyberpunk 2077 164 → 327 (137 → 275), Dying Light ×4
|
||||
at 48 → 194 (beta.42: 54 → 216), Kingdom Come 58.8 presented (59.3).
|
||||
- **An install stops the game's threads once a patch, as a restore does.** The thirteen interposer patches took
|
||||
0.74 s on Phantom Blade Zero, 1.2 s on Cyberpunk 2077, 1.7 s on Dying Light and Wukong (twelve there) and
|
||||
**2.8 s on Hogwarts Legacy** — 57 to 215 ms a patch, while the game starts. That is the cost the proposal to
|
||||
queue patches (§What this release decided) would cut, measured on real games.
|
||||
- **No stop was exercised.** Every session ended with the game closing, so no log has an `UNHOOK_RESTORED` line.
|
||||
Item 43 (g) said a log "ends with an `UNHOOK_RESTORED` line for each patch": that is true only of a session
|
||||
stopped while its game runs, and the item was worded wrongly.
|
||||
- **Not exercised: off means off** — Advanced metrics was on in every session. **Not visible in the data**: (c), whether *loaded* agrees with the game's own menu, and (h), the
|
||||
catalog's wording on the page — both are what the owner sees.
|
||||
- **For train C's spike**: Streamline says Reflex is supported in all five games and loaded in the three that
|
||||
ask; Cyberpunk 2077 and Dying Light switch it off and on (`spike-notes` §30 has the note).
|
||||
|
||||
### NEXT
|
||||
|
||||
1. ~~**The owner runs item 43**~~ **Run and read 2026-11-13** (§What the owner's seven sessions on beta.45
|
||||
showed): five of the six calls read in real games, nothing different on the way out, no fault. *Off means off*
|
||||
was not exercised, and `slAllocateResources` was called by no game.
|
||||
2. ~~**The owner reads `spike-notes` §30 and answers its three questions.**~~ **Answered 2026-11-13 (D132,
|
||||
D133)**: route D goes to a spike on `hook-harness` and a stub — the owner ruled that a driver's read-only getter
|
||||
called with the device of the hooked swap chain is inside rule 4 — and no real game is touched before the owner
|
||||
has seen its result (`spike-notes` §31, to be written after 0.1.0-beta.46 is tagged); route C is refused; the
|
||||
ETW route stays closed. No shipped code changes for the spike.
|
||||
3. ~~**The stop's cost** (above): whether to batch the restores is the owner's to say.~~ **Decided 2026-11-13
|
||||
(D134): batch them, installs too** — a pull request of its own, measured on the harness, released alone as
|
||||
**0.1.0-beta.46**. The plan was reviewed against MinHook's source before it was approved: `MH_ApplyQueued`
|
||||
applies every entry whose queued state differs, not only the caller's, so the queue-to-apply sequence is
|
||||
serialised, only targets that are still ours are ever queued for a restore, and nothing is queued "for all".
|
||||
4. **`slAllocateResources` keeps its patch** (D135); looked at again with more sessions.
|
||||
5. **Train D** after train C, the same way: a spike first.
|
||||
|
||||
### Left open by this session
|
||||
|
||||
- ~~**This release's own facts** — the tag's run, the digests, the delta — are not in any file yet: the release is cut
|
||||
after this text. Record them in the next pull request, with what SonarCloud and Qodana said.~~ **Recorded
|
||||
2026-11-12: 0.1.0-beta.45 was released 2026-11-12T16:40:42Z** (23:40 in the owner's time zone) from the signed
|
||||
tag on `550d830` (#431), by run 43257803723 — green at the first attempt, one run for the one tag push. Eight
|
||||
assets; the seven digests of `SHA256SUMS.txt` equal the ones GitHub computed; the four shipped natives carry
|
||||
`FL_BUILD_ID v0.1.0-beta.45`. The delta from beta.44 is 1,762,465 bytes beside a full package of 110,767,499 —
|
||||
"Delta processed 0452 files. 0024 patched, 0428 unchanged". The wiki was published by run 43261335359. The
|
||||
rehearsal on the release branch (run 43253780609, at `f4e3fe2`, the released tree) had made a delta of 1,779,418
|
||||
bytes with the same file counts. **Qodana's two reports are green on `550d830`.** On the way Qodana's native
|
||||
report found two index products in the harness's probe (#427), fixed before that pull request merged; every
|
||||
later report was clean, and each was read before its merge. No required check failed on this train.
|
||||
**SonarCloud's quality gate failed on `550d830`, on one condition: duplicated lines on new code, 3.7 % where the
|
||||
gate allows 3 %.** No issue is open and coverage on new code is 98.6 %. The 39 lines are the six new members of
|
||||
`FlHookFamily` (`ShmLayout.cs`) and of its Domain mirror `HookFamilies` — two enums that are the same on purpose
|
||||
(Domain references nothing, and `MetricEnumMirrorTests` fails when they differ), which six members at once took
|
||||
over a threshold that two at a time had stayed under. The job is advisory and the release was already cut. The
|
||||
pull request that records this leaves the Domain's mirror out of duplication detection, with the reason in
|
||||
`SonarQube.Analysis.xml` and in `13_CI_CD` §SonarCloud; **whether the gate is green again is for the analysis of
|
||||
that commit on `main` to say**, and it is not in this text. *(It said so the same night: green on `d3e8dd3`,
|
||||
duplicated lines on new code 0.0 %, no issue open.)* One more thing the train showed: main's branch
|
||||
protection wants a pull request up to date, so of two that were green at once the second (#430) had to be
|
||||
rebased after the first merged, and ran its checks again.
|
||||
- ~~**No real game was run on this build.** Six new patch sites, tested with the harness and the stub; their cost
|
||||
measured on the headers.~~ **Seven sessions on six games, 2026-11-13** (§What the owner's seven sessions on
|
||||
beta.45 showed). The published release notes say the six calls "have not been run in a real game"; a released
|
||||
file is not edited.
|
||||
- **`slAllocateResources` has a patch no game has used**: not called after the attach in any of six sessions on
|
||||
five games. ~~Whether it stays is the owner's.~~ It stays for now (D135, 2026-11-13).
|
||||
- **Off means off (item 42 (f)) has never been exercised on a real game**; it is item 43 (f) now, for all ten.
|
||||
- **Valor Mortis's crash at 51 s** (twice, beta.40 and beta.44) **and Black Myth: Wukong's fault in Steam's crash
|
||||
handler at every exit** are not explained. One session of each with hooking off is the comparison that is missing.
|
||||
- **What item 41 left unexercised**: a configure through the FidelityFX 2.3 loader (Cyberpunk 2077 with FSR frame
|
||||
generation), a game with neither library.
|
||||
- **A fault while a game is closing is not seen by a hooked session** (D127: written down, not changed).
|
||||
- **`docs/LIST_GAME_TESTED.md` is as of 2026-11-06**: refreshing it is a new copy of the ledger and the owner's review.
|
||||
- **Item 40 (d)** was not exercised and the owner has not said item 40 passed. **Items 36 (d) and 37 are still open.**
|
||||
- **What an empty process snapshot does to the watcher's tick in a real session** was not looked into (seen once in
|
||||
a test on 2026-11-12).
|
||||
- **`LIMITATIONS.md` and the accuracy statement still say the processor's, the memory's and the motherboard's
|
||||
sensors "have never been read on real hardware"** — the owner's to reword. The alpha line still rests (D98).
|
||||
|
||||
**Owner-only:** item 43; the three questions of `spike-notes` §30; one session each of Valor Mortis and Black
|
||||
Myth: Wukong with hooking off; what item 41 left unexercised; item 40 (d).
|
||||
@@ -0,0 +1,247 @@
|
||||
# HANDOFF history — 0.1.0-beta.46
|
||||
|
||||
*Moved verbatim from `docs/HANDOFF.md` when 0.1.0-beta.47 was cut, 2026-11-14 (owner decision D66); `docs/HANDOFF.md` §How this file is split lists every part. Nothing below was edited, so its "below" and "above" mean HANDOFF.md as it stood then, and a path it writes is relative to `docs/`. **Its §The train after 0.1.0-beta.46 says the release is held**: item 44 (d) was run on 2026-11-14 and 0.1.0-beta.47 was released that day; what it built and decided is HANDOFF.md's section for it.*
|
||||
|
||||
## **START HERE** — 2026-11-13, 0.1.0-beta.46: patches go in and come out under one stop of the game's threads; Reflex route D goes to a harness spike
|
||||
|
||||
*Status is `docs/changelog/0.1.0-beta.46.md`; this is what no other file carries.* The owner ran seven sessions on
|
||||
beta.45 the day after it was released and said: check the logs and go on. They were read from a copy of the ledger
|
||||
and the logs (#433), and the same day the owner took four decisions on what they showed (D132–D135) and approved
|
||||
the plan. Two pull requests and this one: #433 (what the sessions showed; the decisions; rule 4's note in
|
||||
`CLAUDE.md`), #434 (the batches, D134). **What the seven sessions on beta.45 showed, session by session, is
|
||||
[`handoff/history/0.1.0-beta.45.md`](handoff/history/0.1.0-beta.45.md)**; what the batches are, what the queue
|
||||
makes dangerous and what was measured is [`17_HOOK_ENGINE.md`](17_HOOK_ENGINE.md) §Unhooking, *Batches*.
|
||||
|
||||
### What this release decided, beyond D132–D135
|
||||
|
||||
- **The first design was wrong, and reading MinHook's source before writing a line is what found it.** It marked
|
||||
every hook for disabling and then un-marked the ones it must not restore. `MH_ApplyQueued` applies every hook
|
||||
whose mark differs from its state; un-marking a hook that is already out marks it for *enabling*, and the stop's
|
||||
own apply would have put a patch back in after the stop — logged as "declined", with the status `UNHOOKED`. The
|
||||
rules that replaced it are in `fl_patch_registry.h`: no mark left standing, only a patch that is still ours
|
||||
marked for a restore, nothing marked "all", and mark–apply–commit inside a gate.
|
||||
- **The gate is the Overlay's one lock, and it is on no hook body's path.** A slim lock, exclusive, held for one
|
||||
apply, never across a symbol lookup (the loader's lock). The one way from a hook to it is the stop, which always
|
||||
waited for MinHook's own lock and a stop of the threads. Its owner re-enters it without waiting: a slim lock taken
|
||||
twice by one thread never returns.
|
||||
- **The verdict on an install is the engine's, not the bytes'.** Reading the target back after the apply would take
|
||||
a foreign overlay that patched over us in that instant for a failure, and mark a restore nobody had compared.
|
||||
- **An apply stops at its first failure and says only that one failed.** The hooks after it are enabled — in the
|
||||
stop, restored — one at a time, so one bad patch still costs one patch, and a stop still takes everything out.
|
||||
- **One stop of the threads costs what it cost for one patch**: 77–91 ms on the fixture for four, nine or eighteen.
|
||||
What it costs in a game with a few hundred threads is not known; the `PATCH_BATCH` line's `a=` is there to say.
|
||||
- **Init's three DXGI patches, the loader detour and OpenGL are as they were** — three already went in together,
|
||||
the other two are one each. Ray tracing's two are a batch of their own, apart from the upscaler rows', so that a
|
||||
batch's size in a test does not depend on which tick a D3D12 device appeared in.
|
||||
- **`fl_guard`'s timing assertion is on the restore only** (under a second for eighteen patches): the time from an
|
||||
Advanced request to its families includes the wait for the watchdog's tick, and batching changes the tick's
|
||||
phase, so that number went *up* in the test while the install itself went from 0.6 s to 0.08 s. The install is
|
||||
asserted by count — every lazily installed patch under a `PATCH_BATCH` line — not by time.
|
||||
- ~~**The spike of route D is still to be written**~~ **The spike of route D was run the same day** (`spike-notes`
|
||||
§31; `tools/fl-probe-reflex`, ctest `fl_reflex_probe_stub`): a decision table written before the runs, a stand-in
|
||||
`nvapi64.dll`, then the installed driver in the probe's own process. None of §30's stop conditions fired. Two
|
||||
things it decided that a plan must keep: **the call belongs on the presenting thread, once a second** — a call
|
||||
the driver holds stops the thread that made it, so not the watchdog, and at a microsecond or so it needs no thread
|
||||
of its own — and **the newest frames of a report are not final** (one run read a span of half an hour in the
|
||||
newest frame). Rule 4's note (D132) is in `CLAUDE.md`; nothing shipped calls a driver.
|
||||
|
||||
### Traps this train left
|
||||
|
||||
- **GPG's agent had restarted and the pinentry timed out three times in a row**; nothing could be committed until
|
||||
the owner unlocked the key (`echo test | gpg --clearsign` in the owner's own terminal). Say so and go on with
|
||||
what needs no commit — planning did not.
|
||||
- **A here-document still eats backslashes** (a `\n` inside a C++ string in an edit script): write the script to a
|
||||
file. It cost one failed edit again.
|
||||
- **A Catch2 `WARN` longer than the console's width wraps**, and a filter on its first words loses the number at
|
||||
its end: keep a measured line short.
|
||||
- **To measure the old build beside the new one**: `git stash push -- <the changed sources>`, build, run the one
|
||||
test case by name (its `INFO` log prints when a new assertion fails, which it does on the old build), `git stash
|
||||
pop`, build again.
|
||||
- **SonarCloud's gate was red on #434 before it merged, on three things it was right about**: a `LARGE_INTEGER`
|
||||
initialised with `{}` and read through `QuadPart` (cpp:S6232 - write `{.QuadPart = 0}`, as the rest of the file
|
||||
does since #336), a `strlen` in a test, and a test model indexed with what a lookup returned unchecked. Its job is
|
||||
advisory and auto-merge does not wait for it: the pull request was held until the fix was analysed.
|
||||
- **`docs/14_TESTING` and the changelog are where a non-per-present cost goes**; "measured overhead" in a pull
|
||||
request body means what the change can move — here the install and the stop, not a present.
|
||||
|
||||
### What the owner's five sessions on beta.46 showed (item 44, read 2026-11-13)
|
||||
|
||||
The owner updated at 20:29 (+07) the day of the release, ran five Streamline games with Advanced metrics on — one
|
||||
session each, four to nine minutes, sessions 198–202 — and said: check and go on. Read from a copy of the ledger
|
||||
and the logs, and from Windows' application log. None of the five is under the user-mode exception.
|
||||
|
||||
| Session | Game | Install batches in the log's order: `a=` in microseconds · patches | The interposer's patches on beta.45, first line to last |
|
||||
|---|---|---|---|
|
||||
| 198 | Hogwarts Legacy | **1 260 835 · 13** (Streamline) — 261 920 · 3 — 227 061 · 2 | 2.80 s, 0.19–0.31 s a patch |
|
||||
| 199 | Phantom Blade Zero | 81 417 · 3 — 92 512 · 6 — 88 455 · 13 (Streamline) — 99 253 · 2 | 0.74 s and 0.85 s |
|
||||
| 200 | Black Myth: Wukong | 187 931 · 12 (Streamline) — 157 010 · 3 — 109 025 · 2 | 1.65 s |
|
||||
| 201 | Cyberpunk 2077 | 93 168 · 16 (Streamline's thirteen and the FSR loader's three) — **608 700 · 3** — 177 970 · 3 — 120 878 · 2 | 1.18 s |
|
||||
| 202 | Clair Obscur: Expedition 33 | 168 527 · 3 — 165 405 · 16 (Streamline's thirteen and FSR frame generation's three) — 218 172 · 2 | no session on beta.45 |
|
||||
|
||||
- **The batches went in whole.** In every log the `HOOK_INSTALLED` lines above a `PATCH_BATCH install` carry one
|
||||
time to the thousandth of a second; there is no `PATCH_FAILED` and no `UNHOOK_DECLINED`; and the hooks are the
|
||||
ones beta.45 installed for the same game, compared name for name (four games; Clair Obscur had no log on beta.45).
|
||||
- **Sixteen of the eighteen batches cost 81–262 ms, whatever they held** — two patches or sixteen. That is what one
|
||||
patch cost in the same game on beta.45, as expected.
|
||||
- **Two did not, and neither is explained.** Hogwarts Legacy's thirteen took **1.26 s** — under half the 2.8 s they
|
||||
took one by one, and about five times what one stop cost in that game the same afternoon. Three of Cyberpunk
|
||||
2077's took **0.61 s**, which is what three patches cost there one by one. **The log cannot tell one long stop
|
||||
from an apply that failed part-way and was finished one patch at a time**: a batch writes a line only for a patch
|
||||
that fails for good (item 44's text said a fallback leaves a `PATCH_FAILED`; that was wrong). What speaks for one
|
||||
long stop: the queued apply fails only where a page's protection cannot be changed, and thirteen single stops in
|
||||
Hogwarts Legacy would have cost 2.5 s or more. *A reading, not a measurement*: a stop waits until every thread of
|
||||
the game has taken its suspension, and how long that takes follows what the game is doing at that instant — both
|
||||
happened while the game was loading — and not how many patches the stop covers.
|
||||
- **What that means for a ceiling on a batch** (item 44's own words for a second or more, written before the run):
|
||||
the eighteen batches say the cost does not follow the count — sixteen patches in 93 ms, three in 609 ms — so
|
||||
splitting a batch would add stops, not shorten one. What is missing is the line that says how a batch ended.
|
||||
- **Nothing else moved.** All five hooked, `normal`, no fault counted, no record dropped. Rates and factor beside
|
||||
each game's earlier sessions: Cyberpunk 2077 149 → 298 (×2.0) beside 164 → 327 and 137 → 275; Hogwarts Legacy
|
||||
61 → 245 (×4.0) beside 59 → 236; Black Myth: Wukong 78 → 315 (×4.0) beside 85 → 341; Phantom Blade Zero 87 → 261
|
||||
(×3.0) beside 81 → 244 at ×3.0 on beta.43; Clair Obscur 112 → 339 (×3.0) beside 106 → 323 on beta.44.
|
||||
- **The way out is as it was.** Hogwarts Legacy faults in `_nvngx.dll` at `0x6aa85` and Black Myth: Wukong in
|
||||
Steam's `crashhandler64.dll` at `0x39b49` — the module and the offset of every build read so far. The other
|
||||
three games leave nothing in Windows' application log.
|
||||
- **The Advanced rows are as on beta.45**, and Clair Obscur gave its first reading of the six calls (interposer
|
||||
2.7.30): `slIsFeatureSupported` and `slIsFeatureLoaded` read, among them a feature no session had named before,
|
||||
`kFeatureLatewarp` (Streamline's answer: `eErrorFeatureMissing`). `slAllocateResources` and `slShutdown` were
|
||||
called in none of the five (D135 stands). That game's `hook_crash_count` of 3 is old: it dates from 2026-10-20
|
||||
and is the same in the copy read for item 43.
|
||||
- **Not exercised: the stop.** Every session ended with its game exiting; no log has a `STOP` or a `PATCH_BATCH
|
||||
restore` line. **`RestoreAll` has still run in no real game** — item 44 (d). Nor (e), a game with no Streamline,
|
||||
nor (g), off means off: `telemetry.advanced` was on throughout. (c), how a game's start feels, is the owner's to
|
||||
say. (a) held: the terms window did not show.
|
||||
|
||||
### The train after 0.1.0-beta.46: Reflex route D in a game, and D137 (plan approved 2026-11-13)
|
||||
|
||||
*Nothing of this is in a release. The release pull request is not opened before the owner has run item 44 (d).*
|
||||
**Where it stands (2026-11-14):** all five are merged — #440 (PR-0), #441 (D137), #442 (the words), #443 (the
|
||||
Overlay), #444 (the Agent, the App, the legal texts, owner-only item 45); `main` is `cd4f69a`. What is left is the
|
||||
release, which waits for the owner: **item 44 (d) was tried on 2026-11-14 and not exercised** (the switch was on
|
||||
before the games started — item 44's last paragraph). **Not verified by any test: the whole path through the real Agent** —
|
||||
the injected tests stop at the shared memory, the sampler's tests start from it; no end-to-end case loads the
|
||||
stand-in module under an Agent session. The Japanese strings are new and unreviewed, as every `ja` string is.
|
||||
The owner approved the plan the evening item 44 was read. Its order: **PR-0** the decisions and the probe's leg
|
||||
with a sleep (done: `spike-notes` §31 — no stop condition) → **PR-1** D137 → **PR-2** the words in region 5, written
|
||||
by nobody → **PR-3** the Overlay, the gates, the fixtures → **PR-4** the Agent, the App, strings, documents, legal
|
||||
texts and owner-only item 45 → **the release, held**. What the plan's review against the source decided — a draft
|
||||
of mine was wrong in six places — and that no other file carries yet:
|
||||
|
||||
- **Resolve on the watchdog, once for the process; call on the presenting thread.** The watchdog asks Windows for
|
||||
an `nvapi64.dll` that is *already loaded* (never loads it), only while a session asks for Advanced metrics and a
|
||||
Direct3D 12 device is held; it keeps one reference and never releases it; it refuses a module in the executable's
|
||||
own folder (D140); it fetches `nvapi_QueryInterface` and the two ids under a guard and checks with `VirtualQuery`
|
||||
that both addresses lie inside ~~that module~~ an image the process has loaded. "No getter" and "refused" are
|
||||
final for the process; "no module" is asked again each second. **Found when the header was run against the
|
||||
installed driver: `nvapi64.dll` is a shim and the two getters are in `nvapi64_impl.dll`** (`spike-notes` §31,
|
||||
*What moving the sequence into the Overlay found*) — so the check accepts another loaded image, a reference is
|
||||
kept on that image as well, and the code that is called *is* a Control Flow Guard image (the plan's review had
|
||||
reasoned from the shim, which is not).
|
||||
- **One atomic gate with four states** — idle, armed, reading, off — not a busy flag beside accumulators (two
|
||||
presenting threads could read back to back, and the watchdog could drain half a read). The watchdog drains only
|
||||
when it sees *idle* and arms at most once a second by its own clock (the loader detour wakes it more often); a
|
||||
present does one relaxed load, takes *armed* to *reading*, reads into a static buffer (the report is 15.4 KB: never
|
||||
on a game thread's stack), and stores *idle* or *off*. A request that goes off takes *armed* back.
|
||||
- **After the record is published, and only for a swap chain whose device is the one held** (`g_d3d12Device` is the
|
||||
first device seen, not "this chain's": a flag in the chain's slot, set in `ResolveApi`).
|
||||
- **The latches, each until the game exits**: a fault in a getter (its own guard with `FlFilter`; counted once
|
||||
through `NoteFault`, so the session shows it and it cannot reach the three that self-disable); one call of 2 ms or
|
||||
more (D141); the watchdog finding *reading* on two ticks running — logged and flushed at once, published as
|
||||
stalled, and **nothing can stop a call that does not return**. An error status or an empty report is recorded and
|
||||
reading goes on.
|
||||
- **What D141 costs, measured once on a busy PC** (`spike-notes` §31, *A run on a busy PC*): the 2 ms latch will
|
||||
sometimes fire on a pause that was Windows' and not the driver's — a few sessions in a hundred at worst, by a
|
||||
reading of one run. The owner chose one call over two knowing it errs towards the game; item 45's outcomes must
|
||||
say how the two are told apart (the microseconds published with *slow*). **Asked again with this run in hand,
|
||||
the owner kept it: one call (2026-11-13). Do not re-ask.**
|
||||
- **The summary**: only frames newer than the last one summed; the two newest of a report skipped (§31: not final);
|
||||
a zero end point is "span not reported" (published as all ones), not a refused frame; a frame is refused for a
|
||||
span that runs backwards, one over a second, or no total; frame ids that go backwards restart the sequence.
|
||||
- **Layout 5 stays**: the ten reserved words of region 5's first line take it (`slShutdowns` is the precedent; the
|
||||
handshake compares the build id anyway, and a trial must be removable without a layout 7). The sleep interval is
|
||||
not stored. No new request word (D138). `FL_HOOK_REFLEX`, `FL_MEASURED_LATENCY` and `reflexLatencyUs` stay unset:
|
||||
there is no hook, and the numbers are a series beside the frames; `sessions.reflex_active` stays NULL.
|
||||
- **Managed side**: a new reach, `GameDriver`, not a relaxed test of `Game` (whose meaning is "the arguments of a
|
||||
call the Overlay hooks"); `nvapi.reflex.frame_report` as seven series, `nvapi.reflex.sleep_status` as a table of
|
||||
switches *seen on / seen off*; `nvapi.reflex.mode`, `sl.reflex.state` and `sl.pcl.markers` become *refused* with
|
||||
the reason; `InGameAdvancedSampler.Take` must read the latency state when the mask is zero and keep the new bit
|
||||
out of `SawAnything`.
|
||||
- **The gates**: `overlay-fields-check` learns the two NVAPI structs (`frameID` joins the shared members; `version`
|
||||
is written outside the header); `nvapi-readonly-check` gets a pass over the Overlay — no `NvAPI_*(` token, every
|
||||
id that equals one of `nvapi_interface.h`'s on a list of exactly two, `Sleep` a writer verb; `hookinventory-check`
|
||||
refuses an `nvapi` import. The injected tests prove nothing about Control Flow Guard (the harness does not enforce
|
||||
it): the probe includes the header that ships, so `fl_reflex_probe_stub` tests the shipped sequence under it.
|
||||
- **The legal texts change in PR-4** (Disclaimer 2.16, Privacy Policy 2.20, the accuracy statement): the part
|
||||
inside the game now *makes a call of its own*, once a second, on the game's presenting thread.
|
||||
|
||||
### NEXT
|
||||
|
||||
1. ~~**The owner runs item 44**~~ **Read 2026-11-13** (§What the owner's five sessions on beta.46 showed): the
|
||||
install half held in five games. **Still to run, the owner's: (d) a stop while a game runs** — *Disable all
|
||||
hooking* with a game being recorded — which is the half of beta.46 no real game has exercised; (e) a game with
|
||||
no Streamline; (g) off means off. Not first on a game under the user-mode exception's trial (D38).
|
||||
~~**Proposed, not done: `PATCH_BATCH` says how the batch ended**~~ **Decided the same evening (D137):
|
||||
`PATCH_BATCH` says how the batch ended** — under one apply, or finished one patch at a time, and how many — so
|
||||
that a long `a=` can be read. It goes with the next release, not in one of its own. **Written 2026-11-13**:
|
||||
`install` / `restore` for one apply, `install singly` / `restore singly` with the count in the high half of `b`
|
||||
(`17_HOOK_ENGINE` §Unhooking, *Batches*). It explains nothing about the two long batches already seen; it makes
|
||||
the next one readable.
|
||||
2. ~~**The spike of Reflex route D on `hook-harness`**~~ **Done 2026-11-13** (`spike-notes` §31): on the harness
|
||||
and against the installed driver the two getters are harmless, cost about a microsecond and return a readable
|
||||
report, and the Direct3D 12 device the Overlay holds is what the driver takes. **The owner's next word is go or no
|
||||
for one real title** — a go is a plan of its own before any code (where the numbers go, the Disclaimer's and the
|
||||
Privacy Policy's wording, `nvapi-readonly-check` over the Overlay). Routes C and E are closed (D133).
|
||||
**The owner said go on 2026-11-13 (D136): a plan first, for Cyberpunk 2077.** No code before the plan is
|
||||
approved, and no release that carries it before item 44 (d) — the stop while a game runs — has been run.
|
||||
**The plan was approved the same evening, with D138–D141** (§The train after 0.1.0-beta.46).
|
||||
3. **`slAllocateResources`** keeps its patch (D135); looked at again when there are more sessions.
|
||||
4. **Train D** after train C, the same way: a spike first — and §30 found its hook would miss a game that fetched
|
||||
its functions before the attach.
|
||||
|
||||
### Left open by this session
|
||||
|
||||
- ~~**This release's own facts** — the tag's run, the digests, the delta — are not in any file yet: the release is cut
|
||||
after this text. Record them in the next pull request, with what SonarCloud and Qodana said.~~ **Recorded
|
||||
2026-11-13: 0.1.0-beta.46 was released 2026-11-13T11:10:28Z** (18:10 in the owner's time zone) from the signed
|
||||
tag on `47f010a` (#435), by run 43412434074 — green at the first attempt, one run for the one tag push. Eight
|
||||
assets; the seven digests of `SHA256SUMS.txt` equal the ones GitHub computed; the four shipped natives carry
|
||||
`FL_BUILD_ID v0.1.0-beta.46`. The delta from beta.45 is 634,023 bytes beside a full package of 110,767,120 —
|
||||
"Delta processed 0452 files. 0021 patched, 0431 unchanged". The wiki was published by run 43414965433. The
|
||||
rehearsal on the release branch (run 43409330961, at `7b4ecd7`, the released tree) had made a delta of 668,012
|
||||
bytes with the same file counts. **SonarCloud answered on `47f010a`: the quality gate passed and no issue is open
|
||||
on `main`. Qodana's two reports are green on that commit.** On the way SonarCloud was red on #434 (six issues
|
||||
in the new code, fixed before it merged — §Traps), and no required check failed.
|
||||
- **A local gate once counted `fl_guard` as passed after 0.66 s** (2026-11-13 17:30, the spike's branch). The
|
||||
security software on the development PC was switched on for three minutes while the gate ran; the freshly linked
|
||||
`fl_guard_test.exe` was removed from the build tree, **ctest reported the run that was cut short as `Passed`**
|
||||
(the suite takes 181 s), and the gate went red only because the next test, `fl_prescan`, runs the same executable
|
||||
and could not find it. Run again with that software off, the gate was green. Nothing was changed for it: a test
|
||||
whose process ends early with a zero exit code is a pass to ctest, and the suite has no line it must print to
|
||||
count. ~~Worth a guard of its own (a `PASS_REGULAR_EXPRESSION` on Catch2's last line, or a minimum number of test
|
||||
cases); proposed, not done.~~ **Done the same evening, on the owner's word**: every native test names the line it
|
||||
ends on and ctest requires it; a test registered without one fails the configure; four canaries prove the rule
|
||||
red and green (`14_TESTING` §Native unit tests; `src/native/CMakeLists.txt`). Two things it turned up: four tests
|
||||
passed on a line they print in the middle of their run, and `fl_nvapi_probe` passed whatever it printed after its
|
||||
branch line — a pass expression makes ctest ignore the exit code.
|
||||
- ~~**No real game was run on this build.**~~ Five were, on 2026-11-13 (above): the order in which patches reach a
|
||||
game changed for every game, and the five took it. **The restore under one apply has run in no real game.**
|
||||
- **Two batches took 1.26 s and 0.61 s and nothing explains them** (Hogwarts Legacy, Cyberpunk 2077); the log has
|
||||
no line that tells a long stop from a batch finished one patch at a time.
|
||||
- **Off means off has never been exercised on a real game** (item 43 (f), now item 44 (g)); nor (c) and (h) of
|
||||
item 43, which only the owner sees.
|
||||
- **Valor Mortis's crash at 51 s** (twice, beta.40 and beta.44) **and Black Myth: Wukong's fault in Steam's crash
|
||||
handler at every exit** are not explained. One session of each with hooking off is the comparison that is missing.
|
||||
- **What item 41 left unexercised**: a configure through the FidelityFX 2.3 loader (Cyberpunk 2077 with FSR frame
|
||||
generation), a game with neither library.
|
||||
- **A fault while a game is closing is not seen by a hooked session** (D127: written down, not changed).
|
||||
- **For the inline patches the comparison has never been re-made under the write window** (`17_HOOK_ENGINE`
|
||||
§Compare-and-restore says so now): MinHook owns that window.
|
||||
- **`docs/LIST_GAME_TESTED.md` is as of 2026-11-06**: refreshing it is a new copy of the ledger and the owner's review.
|
||||
- **Item 40 (d)** was not exercised and the owner has not said item 40 passed. **Items 36 (d) and 37 are still open.**
|
||||
- **What an empty process snapshot does to the watcher's tick in a real session** was not looked into (seen once in
|
||||
a test on 2026-11-12).
|
||||
- **`LIMITATIONS.md` and the accuracy statement still say the processor's, the memory's and the motherboard's
|
||||
sensors "have never been read on real hardware"** — the owner's to reword. The alpha line still rests (D98).
|
||||
|
||||
**Owner-only:** item 44 (d), (e), (g) and what (c) felt like — **(d) is what the next release waits for**; item 45 once that release exists; the go or no on `spike-notes` §31 (one real title); one session each of Valor Mortis and
|
||||
Black Myth: Wukong with hooking off; what item 41 left unexercised; item 40 (d).
|
||||
@@ -0,0 +1,146 @@
|
||||
# HANDOFF history — 0.1.0-beta.47
|
||||
|
||||
*Moved verbatim from `docs/HANDOFF.md` when 0.1.0-beta.48 was cut, 2026-11-14 (owner decision D66); `docs/HANDOFF.md` §How this file is split lists every part. Nothing below was edited, so its "below" and "above" mean HANDOFF.md as it stood then, and a path it writes is relative to `docs/`. **Its NEXT and its "Left open" were written through the morning of 2026-11-14 as the owner's sessions were read**: what they led to is HANDOFF.md's section for 0.1.0-beta.48.*
|
||||
|
||||
## **START HERE** — 2026-11-14, 0.1.0-beta.47: the part inside a game asks NVIDIA's driver for its latency report; the batch log says how a batch ended
|
||||
|
||||
*Status is `docs/changelog/0.1.0-beta.47.md`; this is what no other file carries.* The owner ran five sessions on
|
||||
beta.46 the evening it was released and said: check and go on. They were read (#439), the owner took six decisions
|
||||
(D136–D141) and approved the plan of the train the same evening, and the five pull requests of it were merged
|
||||
overnight: #440 (the decisions; the probe's leg with a sleep mode), #441 (D137), #442 (the latency words of region
|
||||
5), #443 (the Overlay makes the read; the gates; the fixtures), #444 (the Agent, the App, the legal texts,
|
||||
owner-only item 45). The release was held for item 44 (d), which the owner ran on 2026-11-14 (#445, and below).
|
||||
**What the five sessions showed, the design of the train as the plan's review left it, and the traps of beta.46
|
||||
are [`handoff/history/0.1.0-beta.46.md`](handoff/history/0.1.0-beta.46.md)**; what the read is and what bounds it
|
||||
is [`17_HOOK_ENGINE.md`](17_HOOK_ENGINE.md) §Calls the Overlay makes into a driver; what was measured is
|
||||
[`spike-notes/31-reflex-route-d-harness.md`](spike-notes/31-reflex-route-d-harness.md).
|
||||
|
||||
### What this release decided, beyond D136–D141
|
||||
|
||||
- **It is the first thing the Overlay does in a game that is not reading a hooked call's arguments**, and it is
|
||||
listed as that — its own table in `17_HOOK_ENGINE`, its own reach in the catalog (`GameDriver`, not a stretched
|
||||
`Game`), its own paragraph in the Disclaimer. A second call of this kind needs a ruling of the same kind (D132).
|
||||
- **Resolve on the watchdog, once for the process; call on the presenting thread, after the record is published,
|
||||
behind one gate of four states** — idle, armed, reading, off. The plan's first draft had a busy flag beside
|
||||
accumulators: two presenting threads could have read back to back, and the watchdog could have published half a
|
||||
read. The whole design as reviewed is in the history file, §The train after 0.1.0-beta.46.
|
||||
- **`nvapi64.dll` is a shim.** The check that the two addresses lie inside the module it asked refused the real
|
||||
driver: the getters are in `nvapi64_impl.dll`, in the driver's store. An address is accepted when it is executable
|
||||
code of a loaded image, and a reference is kept on that image too. Only the run against the installed driver
|
||||
could find it — the stand-in answers with addresses of its own.
|
||||
- **The code that is called is a Control Flow Guard image**; the plan's review had reasoned from the shim, which is
|
||||
not. The probe enforces CFG and makes the calls from the header that ships, so this driver's getters are valid
|
||||
targets. A CFG-enforcing game on another driver is not covered, and a refusal there is a fast-fail.
|
||||
- **The layout stayed 5**: ten reserved words of region 5 took the read. `FL_HOOK_REFLEX`, `FL_MEASURED_LATENCY`
|
||||
and `reflexLatencyUs` stay unset — there is no hook, and the numbers are series beside the frames.
|
||||
- **D141 was asked twice.** A run on a busy PC showed the 2 ms latch can fire on a pause that was Windows'; the
|
||||
owner kept one call. Do not re-ask without a real game's numbers.
|
||||
- **What the game asked of Reflex, and Reflex through Streamline, are `RefusedRoute`** — a patch at a run-time
|
||||
address, and a call the vendor forbids from another thread (D133). `sl.pcl.markers` waits for train D's spike.
|
||||
|
||||
### What item 44's last part showed (2026-11-14)
|
||||
|
||||
- **A first try did not exercise it** (sessions 203–205, #445): *Disable all hooking* was on before the games were
|
||||
started, so two sessions were `RefusedKillSwitch` with nothing injected, and the hooked one ran to its exit.
|
||||
- **The second try did, twice, in Phantom Blade Zero** (sessions 206 and 207): the game started with the switch
|
||||
off, was recorded for a minute and a half, and the switch was turned on while it ran. Each log has `STOP` at the
|
||||
next safety scan, **an `UNHOOK_RESTORED` line for every one of the twenty-nine patches, all at one time**, one
|
||||
`PATCH_BATCH restore` — **83 309 µs and 85 578 µs for twenty-nine** — and `STOP_FLUSHED … a=1`. Nothing was
|
||||
declined. Both sessions ended `KillSwitchEngaged`, tier 1, no fault, no record dropped, writer status
|
||||
*unhooked*; the game ran on for three and four minutes and closed with nothing in Windows' application log.
|
||||
Restoring twenty-nine one by one would have cost about 2.4 s at this game's 84 ms a stop.
|
||||
- **Not said by the logs**: whether the owner felt a hitch at the stop. Not exercised: (e) a game with no
|
||||
Streamline and (g) off means off — both are parts of item 45 now.
|
||||
|
||||
### Traps this train left
|
||||
|
||||
- **A bash here-document ate backslashes again** and wrote a NUL byte into a `.cpp`. Edit scripts are files.
|
||||
- **A file made by the Write tool is LF**; `dotnet format --verify-no-changes` fails a new `.cs` for it. Convert.
|
||||
- **`NvAPI_Status(__cdecl*)(…)` is a call by name to `nvapi-readonly-check`**: the status type has an alias in
|
||||
`fl_reflex.h`. And a member of the Overlay's own named like a vendor's (`fgMultiplier`) fails
|
||||
`overlay-fields-check` outside the header.
|
||||
- **A copy of the harness in `%TEMP%` leaves an overlay log the run's sweep does not own** (it matches this
|
||||
build's harness by path): the test that makes the copy sweeps it.
|
||||
- **Stacked pull requests, with a dirty tree**: once the lower one is squash-merged GitHub retargets the next to
|
||||
`main`; `gh pr update-branch` works while the upper branch only adds, and conflicts once it edited lines the
|
||||
lower one added — then `git rebase -S --onto origin/main <lower tip> <branch>` and a forced push with lease.
|
||||
- **Advisory checks found real things after the local gate was green**: SonarCloud a `wcslen`, Qodana's native
|
||||
report a `switch` that did not name two enumerators, its managed report two redundant qualifiers and a
|
||||
redundant `!`. Hold a merge until both have reported.
|
||||
- **The probe's numbers depend on what else the PC does**: a run beside a build read 3.4 µs where three alone read
|
||||
2.6, and saw reads of 2 ms. Say which kind a number is.
|
||||
|
||||
### NEXT
|
||||
|
||||
1. ~~**The owner runs item 45**~~ **Run on 2026-11-14 in Phantom Blade Zero, three sessions: the read works in a
|
||||
real game** (item 45's last paragraphs) — the driver was found, read every second, and no call took more than
|
||||
45 µs. **Cyberpunk 2077 followed the same morning, twice, and three games the read must leave alone** (sessions
|
||||
211–215): read, 65 µs at the slowest, and *not read* where it should be. **Still to run of it**: Reflex off in
|
||||
a game's menu, off means off; and the owner's word on whether the games felt different.
|
||||
2. **The owner answered on the *GPU render* line (2026-11-14): read the driver's active time.** Two more members
|
||||
of the report FrameLedger already fetches — no further call into the driver. ~~**Plan first**~~ **Planned and
|
||||
approved the same day as the train of 0.1.0-beta.48 (D142–D147)**: the native half first, then the Agent, the
|
||||
App and the texts, then the sampling period, then the release and owner-only item 46 — one batch of tests for
|
||||
the owner, with what is left of item 45 in it. What the plan gathered: the multiplier row that keeps only the last value, the pages that still say no real game
|
||||
was read, the Agent's 1.32 s between samples beside `hz` 1.0. The owner tests what is left once, on that
|
||||
release. Still the owner's to say: more titles; the session summary's latency fields; D141 (the slowest call
|
||||
seen in a game is 65 µs, thirty times under it).
|
||||
3. **`slAllocateResources`** keeps its patch (D135); looked at again when there are more sessions.
|
||||
4. **Train D** after train C, the same way: a spike first — `sl.pcl.markers` waits for it, and §30 found its hook
|
||||
would miss a game that fetched its functions before the attach.
|
||||
|
||||
### Left open by this session
|
||||
|
||||
- ~~**This release's own facts** — the tag's run, the digests, the delta — are not in any file yet: the release is cut
|
||||
after this text. Record them in the next pull request, with what SonarCloud and Qodana said.~~ **Recorded
|
||||
2026-11-14: 0.1.0-beta.47 was released 2026-11-14T01:11:19Z** (08:11 in the owner's time zone) from the signed
|
||||
tag on `3d7c273` (#446), by run 43537436561 — green at the first attempt, one run for the one tag push. Eight
|
||||
assets; the seven digests of `SHA256SUMS.txt` equal the ones GitHub computed; the four shipped natives carry
|
||||
`FL_BUILD_ID v0.1.0-beta.47`. The delta from beta.46 is 1 820 144 bytes beside a full package of 110 795 507 —
|
||||
"Delta processed 0452 files. 0024 patched, 0428 unchanged". The wiki was published by run 43539059710. The
|
||||
rehearsal on the release branch (run 43534606602, at `43426fe`, the released tree) had made a delta of 1 838 295
|
||||
bytes with the same file counts. **SonarCloud answered on `3d7c273`: the quality gate passed and no issue is open
|
||||
on `main`. Qodana's two reports, CodeQL and `check` are green on that commit.** On the way the advisory checks
|
||||
found three things after local gates were green (§Traps), and no required check failed.
|
||||
- **The release branch's local gate was red once, for a reason outside the code** (2026-11-14 07:20): the freshly
|
||||
linked `fl_guard_test.exe` was gone from the build tree seconds after the gate began — Windows Defender's log has
|
||||
three configuration changes at 07:20:53–56 and no detection; which security program removed the file is not
|
||||
known, and nothing of its settings was looked at further or touched. `fl_guard` ended after 0.72 s **and was
|
||||
counted as failed, not passed**: the rule of #438 (a native test names the line it ends on) did what it was
|
||||
written for. Run again, the gate was green.
|
||||
- ~~**No real game has run the read.**~~ Two have (Phantom Blade Zero and Cyberpunk 2077, 2026-11-14). **The accuracy
|
||||
statement, `LIMITATIONS.md` and the guide still say no real game had been read**: true when written, to be
|
||||
brought up to date with the next release, as beta.46's pages were.
|
||||
- **In Phantom Blade Zero the driver's *GPU render* span is longer than its total** (item 45): shown as reported,
|
||||
not explained. In Cyberpunk 2077 it is not. The owner's answer: read the driver's active time (NEXT 2).
|
||||
- ~~**The Agent's samples are 1.32 s apart while `sensor_blobs.hz` says 1.0**~~ (seen 2026-11-14 in the `t_ms`
|
||||
series). **Looked into the same day (D146)**: the poller waited its whole interval after a poll's work; only
|
||||
the App's series loader reads `hz`, and only where a row has no `t_ms`, so no chart was wrong. The poller now
|
||||
keeps a fixed period and `hz` is measured from the samples (`06_DATA_MODEL` §sensor_blobs) — in no release yet.
|
||||
- **Where the third of a second goes is not established.** Unelevated, a poll takes about a millisecond (the
|
||||
layers composed as the Agent composes them, each read under a stopwatch). In the owner's ledger 180 of 186
|
||||
sessions are 1.32 s apart and six are 1.0 s: the two with no `cpu_temp` series (an Agent not elevated) are among
|
||||
the six — which points at the sensor library's processor update, run on the poll's thread as administrator
|
||||
with PawnIO — **but four sessions that have the series kept one second** (22, 72, 73, 136). **Not measured**:
|
||||
that call itself (it needs elevation), and whether it is processor time or waiting. Not changed; the period no
|
||||
longer depends on it. The owner's to say whether it is worth timing on their PC and moving off the poll's thread.
|
||||
- **No test runs the whole path through the real Agent**: the injected tests stop at the shared memory and the
|
||||
sampler's start from it; no end-to-end case loads the stand-in module under an Agent session.
|
||||
- **Two install batches of beta.46 took 0.61 s and 1.26 s and nothing explains them** (Hogwarts Legacy, Cyberpunk
|
||||
2077). Since this release the log says whether a batch went singly; the next long one can be read.
|
||||
- **The Japanese strings are new and unreviewed**, as every `ja` string is.
|
||||
- **Off means off has never been exercised on a real game** (item 43 (f), item 44 (g), now item 45 (g)); nor (c)
|
||||
and (h) of item 43, which only the owner sees.
|
||||
- **Valor Mortis's crash at 51 s** (twice, beta.40 and beta.44) **and Black Myth: Wukong's fault in Steam's crash
|
||||
handler at every exit** are not explained. One session of each with hooking off is the comparison that is missing.
|
||||
- **What item 41 left unexercised**: a configure through the FidelityFX 2.3 loader (Cyberpunk 2077 with FSR frame
|
||||
generation), a game with neither library.
|
||||
- **A fault while a game is closing is not seen by a hooked session** (D127: written down, not changed).
|
||||
- **`docs/LIST_GAME_TESTED.md` is as of 2026-11-06**: refreshing it is a new copy of the ledger and the owner's review.
|
||||
- **Item 40 (d)** was not exercised and the owner has not said item 40 passed. **Items 36 (d) and 37 are still open.**
|
||||
- **`LIMITATIONS.md` and the accuracy statement still say the processor's, the memory's and the motherboard's
|
||||
sensors "have never been read on real hardware"** — the owner's to reword. The alpha line still rests (D98).
|
||||
|
||||
**Owner-only:** what is left of item 45 (Reflex off in a game's menu; off means off; how it felt); one session
|
||||
each of Valor Mortis and Black Myth: Wukong with hooking off; what item 41 left unexercised;
|
||||
item 40 (d).
|
||||
@@ -0,0 +1,115 @@
|
||||
# HANDOFF history — 0.1.0-beta.48
|
||||
|
||||
*Moved verbatim from `docs/HANDOFF.md` when 0.1.0-beta.49 was cut, 2026-11-14 (owner decision D66); `docs/HANDOFF.md` §How this file is split lists every part. Nothing below was edited, so its "below" and "above" mean HANDOFF.md as it stood then, and a path it writes is relative to `docs/`. **Its NEXT and its "Left open" were written through the afternoon of 2026-11-14 as item 46 was read**: what they led to is HANDOFF.md's section for 0.1.0-beta.49.*
|
||||
|
||||
## **START HERE** — 2026-11-14, 0.1.0-beta.48: two real games read; the driver's own GPU times beside a span that includes idle; every multiplier seen; samples a second apart
|
||||
|
||||
*Status is `docs/changelog/0.1.0-beta.48.md`; this is what no other file carries.* The owner ran eight sessions on
|
||||
beta.47 the morning it was released and said, twice: check. They were read (#448, #449): Phantom Blade Zero three
|
||||
times, Cyberpunk 2077 twice, two Direct3D 11 games and a Direct3D 12 game with no NVIDIA library — **the read
|
||||
works in real games**, and four things came out of it that the owner ruled on the same morning (D142–D147) and
|
||||
approved as one train: #450 (the Overlay reads two more members of the report and keeps the multipliers seen),
|
||||
#451 (the Agent, the App, the texts — Privacy Policy 2.21, Disclaimer 2.17), #452 (the poller's period), and this
|
||||
release. **What the eight sessions showed is item 45's last paragraphs, below; beta.47's own section, its traps
|
||||
and its release facts are [`handoff/history/0.1.0-beta.47.md`](handoff/history/0.1.0-beta.47.md)**; what the
|
||||
read is and what bounds it is [`17_HOOK_ENGINE.md`](17_HOOK_ENGINE.md) §Calls the Overlay makes into a driver.
|
||||
|
||||
### What this release decided, beyond D142–D147
|
||||
|
||||
- **Two more members of a report already fetched are not a new call.** Rule 4's note stands as written: the same
|
||||
two getters, the Overlay's own buffer, the two names on `tools/overlay-allowed-fields.txt`. The owner ruled on
|
||||
them by name (D142); a third member is asked the same way.
|
||||
- **The driver's own times have a count each, and zero means not given.** An older driver leaves both zero, and
|
||||
so did the probe's frames. They are added after the frame is accepted, so which frames the seven spans are made
|
||||
of did not move — a session's old series mean what they meant.
|
||||
- **An entry of their own in the catalog** (`nvapi.reflex.gpu_times`), not an eighth and ninth line of the frame
|
||||
report: `AdvancedPresenter.MaxLines` is 8, and nine series of one entry are drawn as a band.
|
||||
- **The layout stayed 5 again**: line 0 of region 5 was full, so the four words came out of the seven reserved
|
||||
words that ended the `sl::DLSSOptions` line. Three remain there, two on the `sl::Constants` line, two on the
|
||||
FidelityFX line.
|
||||
- **The fact's key no longer holds the last multiplier.** It held it since beta.47, so every menu rewrote the
|
||||
session's context.
|
||||
- **`hz` is measured from the samples, not taken from the setting**: the finalizer cannot see the setting, and a
|
||||
session recovered from a `.partial` file never knew it.
|
||||
- **The plan named `tools/agent-cost` for the poller's change and it was not run**: it runs the Agent unelevated,
|
||||
where a poll takes a millisecond and the period was already a second. Said in #452 rather than run for show.
|
||||
|
||||
### Traps this train left
|
||||
|
||||
- **A cause I wrote down before checking it.** "The third of a second is the processor's temperature" went into
|
||||
five files on two facts — unelevated a poll takes a millisecond; the sessions without a `cpu_temp` series are a
|
||||
second apart — and then four sessions *with* the series turned out to be a second apart too. The texts were
|
||||
taken back to what is established before the commit. **Count the exceptions before naming a cause.**
|
||||
- **A bash here-document ate a backslash again** (a Python one-liner with `'\\'`). Edit scripts are files — the
|
||||
rule already existed.
|
||||
- **`FETCH_HEAD` belongs to the worktree that fetched.** A merge in a second worktree needs the commit's id.
|
||||
- **A squash-merge of the lower pull request conflicts the upper one in `CHANGELOG.md` every time** both added to
|
||||
`[Unreleased]`. With Auto-fix on, the app asks for a merge of `main`, not a rebase: do it in a worktree of its
|
||||
own when a gate is running in the main one, keep the upper branch's file (it is the superset), and check that
|
||||
the merged tree equals the branch's tip — then the gate already run still stands.
|
||||
- **The gate script's last lines do not reach a background task's output**: read the log's last line and hash the
|
||||
`rules` folder by hand.
|
||||
- **An analyzer wants a `<summary>` once any `<param>` is written** (RCS1139).
|
||||
|
||||
### NEXT
|
||||
|
||||
1. ~~**The owner runs item 46**~~ **Run and read 2026-11-14** (the item, below): the samples are a second apart,
|
||||
both games gave both figures, the multipliers are listed, off means off. **The owner's word, the same day: no
|
||||
hitch.** What is left of it is whether session 221 was the one with Reflex off.
|
||||
2. **Then the owner's to say**: more titles; D141 on a larger sample (the slowest call seen in a game is 65 µs);
|
||||
whether the processor update is worth timing on their PC and moving off the poll's thread (below).
|
||||
3. **`slAllocateResources`** keeps its patch (D135); looked at again when there are more sessions.
|
||||
4. **Train D** after it, the same way: a spike first — `sl.pcl.markers` waits for it, and §30 found its hook
|
||||
would miss a game that fetched its functions before the attach.
|
||||
|
||||
### Left open by this session
|
||||
|
||||
- ~~**This release's own facts** — the tag's run, the digests, the delta — are not in any file yet: the release is cut
|
||||
after this text. Record them in the next pull request, with what SonarCloud and Qodana said.~~ **Recorded
|
||||
2026-11-14: 0.1.0-beta.48 was released 2026-11-14T04:49:19Z** (11:49 in the owner's time zone) from the signed
|
||||
tag on `aec1736` (#453), by run 43556901499 — green at the first attempt, one run for the one tag push. Eight
|
||||
assets; the seven digests of `SHA256SUMS.txt` equal the ones GitHub computed, and the portable package hashed
|
||||
here equals its line; the five native libraries in it carry `FL_BUILD_ID v0.1.0-beta.48`, none of them
|
||||
`-dirty`. The delta from beta.47 is 1 944 037 bytes beside a full package of 110 800 248 — "Delta processed
|
||||
0452 files. 0024 patched, 0428 unchanged". The wiki was published by run 43558546949. The rehearsal on the
|
||||
release branch (run 43555020289, at `0c210d0`, the released tree) had made a delta of 1 966 174 bytes with the
|
||||
same file counts. **SonarCloud answered on `aec1736`: the quality gate passed and no issue is open on `main`. Qodana's two reports, CodeQL and `check` are green on that
|
||||
commit**, as they were on each of #450–#453 before its merge; no advisory check found anything in this train.
|
||||
- ~~**No real game has given the two new figures yet.**~~ **Two have (item 46, 2026-11-14)**, in every frame
|
||||
report: Phantom Blade Zero's active render is the short number the reading expected (9.6 ms inside a span of
|
||||
16.4 ms at 60 FPS). **In Cyberpunk 2077 without frame generation active render is longer than the span between
|
||||
the two GPU marks** (3.17 against 2.79 ms) **and why is not established** — the two averages are over different
|
||||
frames, or the driver counts work outside the marks. The label says *idle time included*, which that game's
|
||||
numbers do not show; the texts say the figures are the driver's own. Not changed.
|
||||
- **After a session's first report, 0.4–7.3 % of its samples carry none** (item 46): the Overlay's reads are a
|
||||
second apart or two — its watchdog's tick — and the Agent's samples exactly one. Read in the code, not measured;
|
||||
not changed.
|
||||
- **Where the third of a second of a poll goes is not established.** Unelevated, a poll takes about a millisecond
|
||||
(the layers composed as the Agent composes them, each read under a stopwatch). In the owner's ledger 180 of 186
|
||||
sessions are 1.32 s apart and six are 1.0 s: the two with no `cpu_temp` series (an Agent not elevated) are among
|
||||
the six — which points at the sensor library's processor update, run on the poll's thread as administrator
|
||||
with PawnIO — **but four sessions that have the series kept one second** (22, 72, 73, 136). **Not measured**:
|
||||
that call itself (it needs elevation), and whether it is processor time or waiting. The period no longer
|
||||
depends on it; a poll that takes a third of every second is still a poll that takes a third of every second.
|
||||
- **With the sensor interval above one second, some readings of the driver's report are not stored**: the newest
|
||||
stands until a sample carries it (`SessionRecorder`). Said in the guide; not changed.
|
||||
- **No test runs the whole path through the real Agent**: the injected tests stop at the shared memory and the
|
||||
sampler's start from it; no end-to-end case loads the stand-in module under an Agent session.
|
||||
- **Two install batches of beta.46 took 0.61 s and 1.26 s and nothing explains them.** Cyberpunk 2077's eight
|
||||
batches on beta.47 took 85–221 ms, each in one apply; Hogwarts Legacy has not been run since.
|
||||
- **The Japanese strings are new and unreviewed**, as every `ja` string is.
|
||||
- ~~**Off means off has never been exercised on a real game**~~ **It was, 2026-11-14** (item 46 (e), session
|
||||
226: no `LATENCY` line, none of the hooks Advanced metrics adds, no row). (c) and (h) of item 43, which only the
|
||||
owner sees, are still not.
|
||||
- **Valor Mortis's crash at 51 s** (twice, beta.40 and beta.44) **and Black Myth: Wukong's fault in Steam's crash
|
||||
handler at every exit** are not explained. One session of each with hooking off is the comparison that is missing.
|
||||
- **What item 41 left unexercised**: a configure through the FidelityFX 2.3 loader (Cyberpunk 2077 with FSR frame
|
||||
generation), a game with neither library.
|
||||
- **A fault while a game is closing is not seen by a hooked session** (D127: written down, not changed).
|
||||
- **`docs/LIST_GAME_TESTED.md` is as of 2026-11-06**: refreshing it is a new copy of the ledger and the owner's review.
|
||||
- **Item 40 (d)** was not exercised and the owner has not said item 40 passed. **Items 36 (d) and 37 are still open.**
|
||||
- **`LIMITATIONS.md` and the accuracy statement still say the processor's, the memory's and the motherboard's
|
||||
sensors "have never been read on real hardware"** — the owner's to reword. The alpha line still rests (D98).
|
||||
|
||||
**Owner-only:** one session each of Valor Mortis and Black Myth: Wukong with hooking off; what item 41 left
|
||||
unexercised; item 40 (d).
|
||||
@@ -63,6 +63,37 @@ are kept because they record what each version changed and why (owner decision D
|
||||
>
|
||||
> Version 2.5 (2026-09-27, 0.1.0-beta.10) adds how a tracked game's window is shown — read from Windows — and the engine build name read from an Unreal Engine game's executable. It is also the first version to say two things the software already did: it reads the **content** of a library game's executable (markers in its first 8 MB and its import table, since the detection of engines and features; and, when a session starts, the graphics-library markers in the whole file), and it reads the processor load and the memory in use (since 0.1.0-beta.3). Nothing here leaves your device, as before.
|
||||
|
||||
### What version 2.21 of the Privacy Policy and 2.17 of the Disclaimer changed (0.1.0-beta.48)
|
||||
|
||||
**Two real games had been read, and the texts still said none** (owner decisions D142–D145; the wording's main
|
||||
points approved with the plan of 2026-11-14). The accuracy statement — and so the README and the Disclaimer, which
|
||||
carry it — said the driver's report had been "read with a test program against one driver and one card; no real
|
||||
game had been read when this was written". On 2026-11-14 the owner read it in Phantom Blade Zero and Cyberpunk
|
||||
2077, and the first of them showed something the statement did not say: the stages overlap, and the graphics
|
||||
card's stage — the driver's start mark to its end mark — includes the card's waiting and was longer than the whole
|
||||
frame. So the statement now says both, names the two figures of the driver's own that are shown beside that stage
|
||||
since this release, and says a driver may give neither. The **Privacy Policy** (2.21) adds those two averages to
|
||||
what a session stores, and "its frame-generation multiplier" becomes the multipliers the driver gave during the
|
||||
session. The **Disclaimer** (2.17) changes nowhere else: the component makes no new call, so §2's paragraph on the
|
||||
one call it makes stands as written.
|
||||
|
||||
### What version 2.20 of the Privacy Policy and 2.16 of the Disclaimer changed (0.1.0-beta.47, train C)
|
||||
|
||||
**The part inside a game makes a call of its own** (owner decisions D132, D136, D138–D141; the wording's main
|
||||
points approved with the plan of 2026-11-13). Every earlier version could say that the component reads only what a
|
||||
game passes to the graphics calls it intercepts. With Advanced metrics on, in a Direct3D 12 game that had loaded
|
||||
NVIDIA's driver library, it now also asks the driver, about once a second, for the driver's report of the last
|
||||
frames' stages and its low-latency state. So: the **Privacy Policy** (2.20) names what a session stores of it —
|
||||
durations and five switches, never a time of day, never the moment of an input — in §1's item on Advanced metrics
|
||||
and in §4's list of what the component observes. The **Disclaimer** (2.16) changes three places: "What it observes
|
||||
inside the game" names the report; the sentence "API arguments and nothing else" is replaced by what is true; and
|
||||
§2, after the paragraph on the background thread, gains the paragraph on this call — that it is made on the game's
|
||||
presenting thread, through a library the game loaded and FrameLedger never loads, that two files are kept loaded
|
||||
for it, that it calls nothing that sets or delays, what ends it, and **that a call which never returned could not be
|
||||
stopped**. The accuracy statement loses "PC latency (Reflex)" from "not measured at all" — end-to-end latency
|
||||
still is not measured — and gains the item saying these are the driver's numbers, read from no real game when it
|
||||
was written.
|
||||
|
||||
### What version 2.19 of the Privacy Policy changed (0.1.0-beta.45)
|
||||
|
||||
**Six more calls read inside the game, only while Advanced metrics is on** (train B's fourth step, owner decisions
|
||||
|
||||
@@ -54,3 +54,4 @@ Each section below lives in its own file under `docs/spike-notes/`, moved verbat
|
||||
| §28 | The main line on .NET 11's release — the whole gate, and what the analyses read (2026-11-11, beta.37, D94–D96) | [`spike-notes/28-dotnet11-main.md`](spike-notes/28-dotnet11-main.md) |
|
||||
| §29 | C# 15 against the checks — the canary, and where its constructs would go (2026-11-11, beta.37, D96) | [`spike-notes/29-csharp15-canary.md`](spike-notes/29-csharp15-canary.md) |
|
||||
| §30 | Reflex latency per frame — the routes there are, and what each would cost; a reading, nothing run (2026-11-12, beside beta.45, D130; §M14) | [`spike-notes/30-reflex-latency.md`](spike-notes/30-reflex-latency.md) |
|
||||
| §31 | Reflex route D on the harness — the driver's two getters called from an unshipped probe, against a stand-in module and the installed driver; no game touched (2026-11-13, after beta.46, D132; §M14) | [`spike-notes/31-reflex-route-d-harness.md`](spike-notes/31-reflex-route-d-harness.md) |
|
||||
@@ -46,6 +46,12 @@ game asks about a feature is not that it uses it; 0.1.0-beta.45's `slIsFeatureLo
|
||||
rows will say whether Reflex and PCL are loaded and switched, on the owner's next sessions. No session says
|
||||
anything about a game that uses Reflex without Streamline: none of the hooks sees NVAPI.
|
||||
|
||||
**Added 2026-11-13, from the first sessions on 0.1.0-beta.45** (190–196): Streamline answers `eOk` for
|
||||
`kFeatureReflex` in all five Streamline games run, and `slIsFeatureLoaded` says it is loaded in the three that ask
|
||||
(Phantom Blade Zero, Cyberpunk 2077, Hogwarts Legacy); Cyberpunk 2077 and Dying Light: The Beast switch it off and
|
||||
on through `slSetFeatureLoaded`. `kFeaturePCL` is supported in the four games that ask about it. Loaded is still
|
||||
not in use: whether a game sets markers is what no hook sees.
|
||||
|
||||
### The routes
|
||||
|
||||
**A — hook NVAPI's own functions** (`SetLatencyMarker`, `SetSleepMode`; what `17_HOOK_ENGINE` §Memory / latency
|
||||
@@ -158,3 +164,69 @@ route.
|
||||
would use it); what a
|
||||
real game's interposer and its Reflex and PCL plugins export (the above is the headers' and the source's word,
|
||||
not a dump of a game's files).
|
||||
|
||||
### The owner's answers (2026-11-13, D132 and D133)
|
||||
|
||||
1. **Route D: go — to the spike on `hook-harness` and a stub first.** With it the ruling a go needed: calling a
|
||||
driver's read-only getter with the device of the swap chain the Overlay hooks is inside rule 4 (`CLAUDE.md`
|
||||
carries the note). No real game until the owner has seen the spike's result; no shipped code changes for it.
|
||||
2. **Route C: refused.**
|
||||
3. **Route E: left closed**; §G is not reopened.
|
||||
|
||||
The spike is [`spike-notes` §31](31-reflex-route-d-harness.md), run on 2026-11-13: none of the stop conditions
|
||||
above fired on the harness, and it ends in the question of one real title.
|
||||
|
||||
### Added 2026-11-14: Streamline's two programming guides, read against this note and the code
|
||||
|
||||
`docs/ProgrammingGuideReflex.md` and `docs/ProgrammingGuideDLSS_RR.md` of NVIDIA's Streamline repository, both
|
||||
"Version 2.14.16", fetched as text and read whole — at the owner's request. What they add, and what they change.
|
||||
|
||||
**Reflex**
|
||||
|
||||
- **Low latency and frame generation: the dependency runs one way.** The guide lists the plugin's parts as
|
||||
"distinct to each other without any cross-dependencies", wants Reflex's default to be *On*, and its checklist
|
||||
tests *Reflex On* with frame generation **off**. Frame generation is what needs Reflex. The owner's "without
|
||||
frame generation the game cannot switch Reflex on" is true of some of the owner's games' menus, not of Reflex.
|
||||
The sessions of 2026-11-14 agree (HANDOFF, item 47): low-latency mode on at a multiplier of 1 in four games;
|
||||
Phantom Blade Zero switches it on with frame generation; Clair Obscur without frame generation has it off.
|
||||
- **The sleep and the markers are sent whatever the mode.** "`slReflexSleep` and `slPCLSetMarker` must always be
|
||||
called even when Reflex Low Latency mode is Off"; the verification overlay's *App Called Sleep* stays 1 with
|
||||
Reflex off. So `bUseGameSleep` says the game calls the sleep, **not** that Reflex is on, and a report exists
|
||||
with Reflex off — which is what the sessions on 0.1.0-beta.48 showed (HANDOFF, item 46). Phantom Blade Zero
|
||||
without frame generation is exactly this: the game sleeps, low-latency mode off, 1 062 reads.
|
||||
- **`slReflexSetOptions` is called once, and again only when an option changes.** A hook on it would see nothing
|
||||
in most sessions even if it could be placed: `nvapi.reflex.mode` stays refused for a second reason.
|
||||
- **The markers are the report.** `slPCLSetMarker` replaces `NvAPI_D3D_SetLatencyMarker`, and the times the
|
||||
markers carry (simulation, render submit, present) are the ones the driver hands back in the report this
|
||||
product already reads (route D). `sl.pcl.markers` would add a count of calls, the ping and the flash trigger —
|
||||
nothing a player reads. **Recommended to the owner: leave Reflex and PCL out of train D** — **decided the
|
||||
same evening (D153)**: whether a game has Reflex is all that is wanted.
|
||||
- **PC latency is not in the report, and NVIDIA takes it from outside the game**: its PCL statistics, read by
|
||||
tools started from an administrator's prompt (route E here). D147 stands on that; two design tables that still
|
||||
promised "PC latency as reported by Reflex" were corrected today (`03_METRICS`, `05_DETECTION`).
|
||||
- **The stages, in NVIDIA's words** (the verification overlay's table): *driver* is from the first buffer
|
||||
submission to the last present submission; *OS queue* from the first significant buffer submission to the end
|
||||
of the GPU's work; *GPU* from where its rendering starts to where it ends; *total render time* is "time spent
|
||||
by GPU rendering". With frame generation the test's own columns split the GPU's part at "DLSS FG start". **Not
|
||||
reconciled with what is stored**: an OS queue that ends with the GPU's work should not be shorter than the
|
||||
GPU's span, and in Phantom Blade Zero it is (12.9 ms beside 16.4 ms). The guide's table describes an overlay,
|
||||
not the fields of `NV_LATENCY_RESULT_PARAMS`; nothing is concluded from it, and no label was changed on it.
|
||||
- **Where Reflex helps**, by the guide: GPU-bound, or V-Sync with variable refresh; not CPU-bound. FrameLedger
|
||||
shows the driver's switches and draws no conclusion about benefit.
|
||||
|
||||
**DLSS Ray Reconstruction**
|
||||
|
||||
- **The code already has it right, and two comments had the reason wrong.** The guide: "When DLSS-RR is switched
|
||||
on, it completely overrides DLSS (Super Resolution)", in the quality mode set for DLSS, through
|
||||
`slEvaluateFeature(sl::kFeatureDLSS_RR, …)`. That is the present detour's RR arm (upscaler DLSS, the RR fact
|
||||
beside it), measured on Cyberpunk 2077 on 2026-08-15. `fl_shm.h` and `dllmain.cpp` still said super resolution
|
||||
and RR "run together" / "in the SAME frame"; they do not, and the comments now say what is true.
|
||||
- **Off is a mode, not a release**: "set `sl::DLSSDOptions.mode` to `sl::DLSSDMode::eOff`, note that this does
|
||||
NOT release any resources". So *loaded* and *allocated* (the Advanced tables of 0.1.0-beta.45) are not *in
|
||||
use*; the RR verdict is taken from evaluations and from nothing else, which is why it is right.
|
||||
- **If `sl.dlssd.options` is ever read** (it is a spike entry, set through a call no hook sees): the structure
|
||||
carries `worldToCameraView` and `cameraViewToWorld` — camera matrices, never read (rule 4) — and RR ignores the
|
||||
DLSS options `sharpness` and `useAutoExposure`, so a session's DLSS rows do not describe RR on those two.
|
||||
What the entry would add is RR's preset for each mode and how normals and roughness are packed. Little.
|
||||
- **No dynamic resolution under RR**: a change of input size re-initialises the denoiser. Nothing here depends
|
||||
on it.
|
||||
@@ -0,0 +1,221 @@
|
||||
## 31 · Reflex route D on the harness — the driver's two getters, called from a probe *(2026-11-13, after 0.1.0-beta.46, owner decisions D132, D133; `20_OPEN_QUESTIONS` §M14)*
|
||||
|
||||
**Why this was measured.** §30 read the routes to Reflex latency per frame and left one that needs no patch: the
|
||||
Overlay calling the driver's two getters, `NvAPI_D3D_GetLatency` and `NvAPI_D3D_GetSleepStatus`, with the device of
|
||||
the swap chain it hooks. The owner said go on 2026-11-13 (D132) — **to a spike on the harness first** — and ruled
|
||||
that such a call is inside rule 4 (`CLAUDE.md`, the rule's note). This is that spike. **No shipped code changed and
|
||||
no game was touched**: the call sequence lives in an unshipped probe, and nothing loaded into a game includes it.
|
||||
|
||||
**The instrument.** `src/native/tools/fl-probe-reflex` (built with the Overlay's flags; ctest
|
||||
`fl_reflex_probe_stub` for the half a build machine can run):
|
||||
|
||||
- `fl_reflex_candidate.h` — what would move into the Overlay: find `nvapi64.dll` **if the process already holds
|
||||
it** (never load it), ask its export `nvapi_QueryInterface` for the two getters by the ids of the vendored
|
||||
`nvapi_interface.h`, call them SEH-guarded, summarise the sixty-four frames. It does not link `nvapi64.lib`:
|
||||
the static library loads the DLL itself, from a trusted location and with a signature check.
|
||||
- `--stub`: against `tools/vendor-stubs/stub_nvapi64.cpp`, a stand-in module with knobs for what a driver cannot be
|
||||
made to do on demand.
|
||||
- `--real`: against the installed driver on this PC's NVIDIA adapter, **with the probe playing the game's part** —
|
||||
it loads `nvapi64.dll`, calls `NvAPI_Initialize`, and **sets latency markers on its own device** for a few
|
||||
hundred frames. That is a write, and it is said here plainly: a getter has nothing to return without it, the
|
||||
process is the probe's own, and no shipped binary contains the call (D108's read-only rule is about the Agent's
|
||||
bridge; rule 4's note is about a game). The owner was told and approved it with the plan.
|
||||
|
||||
### The decision table, written before any run
|
||||
|
||||
| # | Measured | Outcome → consequence |
|
||||
|---|---|---|
|
||||
| M1 | Stub: the module absent; a getter absent; an error; a report of nothing; sixty-four reports; both device kinds | Anything called or loaded when the module is absent, or a wrong classification → the candidate is wrong and is fixed before any driver run. Otherwise: these cases are harmless as written. |
|
||||
| M2 | Stub: a call that does not return for 1.5 s, made on a thread of its own and made by a thread that has other work | Made by the busy thread, that thread stands still → **the call may not be made on the Overlay's watchdog** (it supervises, installs and flushes): a thread of its own, or the presenting thread if M6 allows. A thread of its own is a second background thread, and the Disclaimer's sentence about "one" changes. |
|
||||
| M3 | Real: the getters **before** `NvAPI_Initialize` | A fault → a game that holds the module but has not initialised it would fault under us, and the Overlay cannot initialise NVAPI itself (not a getter): **route D stops** unless initialisation can be known without a call. An error status → harmless: read as "not available". |
|
||||
| M4 | Real: initialised, 120 frames, **no marker** | Zero frames or an error → as the header says: a game that does not use Reflex reads N/A. Frames with content → record what the driver fills in by itself. |
|
||||
| M5 | Real: 300 frames **with markers** | Frames with sensible spans → the report is readable by a third party in the process. Zero frames → markers alone are not enough (a sleep mode is needed too): route D reads only games that set one, and the note says so. |
|
||||
| M6 | Real: the cost of one call (2000 calls, on the presenting thread) | NFR-1 allows 1 µs a present. Once a second on the presenting thread costs `call / presents-a-second` a present: at 60 a second a call may cost 60 µs. Median within that → the presenting thread, once a second, is allowed. Above it, or a worst case over 1 ms → **never on the presenting thread**; a thread of its own (M2). |
|
||||
| M7 | Real: the getters on another thread four times a second for 60 s, beside a thread that presents and sets markers | **Any fault → route D stops** (pre-committed, §30). Error statuses or empty reports → recorded; they decide whether a read is trusted. Frames a second beside the poller more than 0.5 % below alone → the rate is too high or the route too costly: lower it and measure again, or stop. |
|
||||
| M8 | Real, Direct3D 12: read with the device, read with the queue, markers on each | The device works → the Overlay already holds it (`g_d3d12Device`). **Only the queue works → Direct3D 12 is out of reach**: the Overlay does not hold the queue (`ResolveApi`: `GetDevice` does not return it) and may not go looking for it. Route D would then be Direct3D 11 only. |
|
||||
| M9 | Real: the unit of the report's times | The gap between two frames' `simStartTime` against the probe's own frame time. Whatever it is, is recorded; a unit that cannot be told → the spans are not shown as times. |
|
||||
|
||||
Not in this spike, whatever it shows: anything in a game; where the numbers would go (shared memory, the Agent, the
|
||||
page); the wording of the Disclaimer and the Privacy Policy. Those are a plan of their own, after the owner's go.
|
||||
|
||||
### Results
|
||||
|
||||
**Where.** The dev box of §Environment: Windows 11 Pro build 29648, RTX 5080, NVIDIA driver 32.0.16.2114
|
||||
(`nvapi64.dll` of the same version), 2026-11-13. `--stub` on software devices; `--real` three times (and a fourth,
|
||||
shorter, after a fix to the probe — row M6), on the NVIDIA
|
||||
adapter, each with a 256×256 composition swap chain presented without a wait — some 14,000 to 17,000 frames a
|
||||
second, which is what makes the cost of anything beside it visible and is nothing like a game.
|
||||
|
||||
| # | What was seen | Against the table |
|
||||
|---|---|---|
|
||||
| M1 | Stub, all 20 checks pass: with the module absent `Resolve` says so, calls nothing and loads nothing; a module without the getters is refused whole; an error comes back as the error; a report of nothing is zero frames; sixty-four reports are read as the header lays them out; the driver is handed the device and only the device, Direct3D 11 and Direct3D 12 alike; no device, no call. | Harmless as written. |
|
||||
| M2 | A call held for 1.5 s on a thread of its own: another thread ticked 16 times in its first second. The same call made by that ticking thread: **0 ticks** in the second. | **Not on the watchdog.** A thread of its own, or the presenting thread (M6). |
|
||||
| M3 | The getters **before** `NvAPI_Initialize`, with the module loaded: both resolve, `GetLatency` returns `NVAPI_OK` and sixty-four empty frames. No fault, three runs. | Harmless: an uninitialised NVAPI reads as "nothing reported". |
|
||||
| M4 | Initialised, 120 frames, no marker: `NVAPI_OK`, zero frames with anything; the sleep status is `NVAPI_OK` with every field zero. | As the header says. A game that does not use Reflex reads N/A, and the read costs it nothing else. |
|
||||
| M5 | 300 frames with markers, **no sleep mode set**: sixty-four frames, the newest one or two ids behind the last frame drawn. Per frame the driver fills simulation end, render submit start/end, present start/end, driver end, OS queue start/end and GPU start/end; `inputSampleTime` and `driverStartTime` stay zero (the probe sets no input marker). | **Readable by a third party in the process, from markers alone.** |
|
||||
| M6 | 2000 calls back to back on the presenting thread: `GetLatency` median **0.50 µs** in the three runs (mean 0.53–0.54, worst 1.2 / 1.5 / 3.0 µs) and **1.50 µs in a fourth**, made that evening after a fix to the probe, with the PC doing other things (mean 1.54, worst 70 µs); `GetSleepStatus` median 0.10 µs in all four, worst 0.7 / 0.8 / 62 / 12 µs. | **Far within NFR-1 once a second**: at 60 presents a second a call may cost 60 µs, and the medians are 0.5–1.5. **Not within it at every present**: the fourth run's median alone is over the microsecond NFR-1 allows a present, and single calls of 62 and 70 µs were seen. Once a second is what is proposed. |
|
||||
| M7 | 60 s, four reads a second from another thread beside the presenting, marker-setting thread, three runs: **228 reads each, none not OK, none faulted, none empty**; worst read 103 / 112 / 248 µs on the polling thread; no marker error. Frames a second beside the poller against alone: −1.3 % (one 60 s leg against one 5 s leg), then in six alternating 10 s legs −1.4 % and −0.6 % — **with single legs between +5.9 % and −9.9 %**. | **No fault: the route does not stop.** The half-percent line cannot be read off this: the loop's own drift from leg to leg is ten times it, in both directions. So a dose was measured instead — next row. |
|
||||
| M7b | The same poller **never pausing**: 38.3 million reads in 30 s (**1.28 million a second**), none not OK, none faulted, worst read 2.7 ms; frames a second −3.3 % (legs −1.1 %, −5.3 %, −3.7 %). | Three hundred thousand times the proposed rate costs about three percent of an uncapped loop. Four reads a second is that divided by 320,000: not measurable, and not half a percent. **The driver also took 38 million reads beside some three million marker calls without an error** — the concurrency §30 could only infer. |
|
||||
| M8 | Direct3D 12: markers set with the **device** — no error; read with the device and read with the queue both return the same sixty-four frames; the sleep status is `NVAPI_OK` with either; markers set with the queue work as well and are read back with the device. | **The device works**, and it is the object the Overlay already holds. |
|
||||
| M9 | `simStartTime` of two neighbouring frames 91 and 43 apart in two runs where the probe measured 81 and 64 µs a frame, and the absolute values are the time of day (1 794 560 148 756 529 on 2026-11-13). | **Microseconds, on the clock of the Unix epoch.** Spans are differences of two of them. |
|
||||
|
||||
**One thing seen that is not understood.** In the first of the three runs the newest frame of the Direct3D 11
|
||||
report had a `presentEndTime` 1 844 674 519 µs — half an hour — after its own `simStartTime`; the other two runs
|
||||
show 36–72 µs there, and the Direct3D 12 reads 46–51 µs every time. The frame was the newest in the report, read
|
||||
within microseconds of being presented. Whatever it was, **the newest frames of a report are not final**: a reader
|
||||
must not take the last few as complete, and must refuse a span that no frame can have.
|
||||
|
||||
### What this settles, and what it does not
|
||||
|
||||
- **Settled, on this driver and this adapter**: the two getters can be found without loading anything and called
|
||||
with a Direct3D 11 device or the Direct3D 12 device the Overlay holds; they do not fault before initialisation,
|
||||
without markers, or beside a thread that sets markers at 16,000 frames a second; a call costs half a microsecond
|
||||
to a microsecond and a half;
|
||||
the report is readable from markers alone and its unit is known. None of §30's stop conditions fired: no fault or
|
||||
hang attributable to the call, no overhead near NFR-1, and the Direct3D 12 device is the one already held.
|
||||
- **Decided by M2 and M6 together**: the call belongs on the **presenting thread, once a second** — a microsecond
|
||||
or so a second, with a worst case seen of 70 µs — not on the watchdog and not on a new thread. So the Disclaimer's "one background thread"
|
||||
would not change; what would change is its list of what the part inside the game does at a present.
|
||||
- **Not settled, because only a game can say**: a game's own device — many threads, deferred contexts, a device a
|
||||
game is about to release; what a real title's report holds (input sample, the GPU times of a real frame, frame
|
||||
generation's `aiFrameTimeUs`); whether a title that uses Reflex through Streamline alone leaves `nvapi64.dll`
|
||||
findable by name (not looked at); a driver other than 32.0.16.2114, and any card but this
|
||||
one; a call that blocks — the stub shows what a block does to its thread, and nothing here made the driver block.
|
||||
- **Not looked into**: Direct3D 11 in the Overlay, which keeps no D3D11 device today (`ResolveApi` releases it):
|
||||
reading there means holding one, a reference the Overlay does not take now; and the incomplete newest frame above.
|
||||
|
||||
### The question for the owner
|
||||
|
||||
**Go to one real title, or stop here?** A go means a plan of its own before any code: the two calls in the present
|
||||
detour once a second, **only while a session asks for Advanced metrics** (D111), only where the game already
|
||||
loaded `nvapi64.dll`, Direct3D 12 first (the device is already held); a place for the numbers — a series beside the
|
||||
frames, since a report arrives after its frame's record is written (§30); `nvapi-readonly-check` extended to the
|
||||
Overlay and taught that `Sleep` is a writer; the Disclaimer's and the Privacy Policy's wording; the first run on a
|
||||
title of the owner's choosing that is not inside the anti-cheat exception's trial (D38), with what each outcome
|
||||
means written before it. A no leaves `nvapi.reflex.*` and `sl.reflex.*` at N/A with the reason, and this note as
|
||||
the record of why it was within reach.
|
||||
|
||||
**Answered 2026-11-13 (owner decision D136): go, to a plan.** The title is Cyberpunk 2077. No code before the plan
|
||||
is approved, and no release that carries the calls before a stop while a game runs has been exercised on
|
||||
0.1.0-beta.46 (owner-only item 44 (d)).
|
||||
|
||||
### The leg with a sleep (owner decision D139) — the table, written before the run
|
||||
|
||||
The plan's review found the largest thing the runs above never touched: **no run set a sleep mode or called
|
||||
`NvAPI_D3D_Sleep`**, and a game that uses Reflex does both, every frame. If the driver makes a getter wait behind
|
||||
the game's sleep, a read on the presenting thread holds a present for as long as the sleep lasts. The owner said:
|
||||
measure it in the probe first (D139). The probe plays the game's part once more — `NvAPI_D3D_SetSleepMode` (low
|
||||
latency on, a minimum interval of 4 166 µs, markers used) and `NvAPI_D3D_Sleep` at the start of every frame, on its
|
||||
own Direct3D 12 device, in its own process. **Both are writes**, as the markers were; no shipped binary contains
|
||||
either, and the sleep mode is switched back off before the device is released.
|
||||
|
||||
| # | What is measured | What it decides |
|
||||
|---|---|---|
|
||||
| S1 | The sleep mode takes: `SetSleepMode` returns OK, the sleep status then reads low-latency on, and a frame takes about the interval | Not OK, or the status does not change → the leg did not exercise a sleep; said so, nothing concluded from S2–S4. |
|
||||
| S2 | The two getters on the thread that sleeps and presents: one `GetLatency` after each of 2000 frames, and 2000 calls back to back | **Median above 60 µs → stop** (NFR-1 at 60 presents a second). **Any call of 2 ms or more → stop**: on a presenting thread that is the latch of D141, in every game that uses Reflex. |
|
||||
| S3 | The getters on **another** thread four times a second for 20 s, and without a pause for 10 s, while the first thread sleeps and presents — against the same two runs on the same device **before** the sleep mode was set | **A fault → stop** (§30). Reads of 2 ms or more that the control does not have → the getter waits behind the sleep: **stop**, and the note says the route reads only games that do not sleep. Reads of 1 ms or more at the same rate as the control → the scheduler, not the sleep. |
|
||||
| S4 | What the report holds once the game sleeps: frames with anything, and the sleep status's fields | Recorded: it is what a real title's report would look like more closely than M5's. An empty report → a sleep mode changes what markers alone gave; recorded, the reader's "nothing reported" covers it. |
|
||||
|
||||
A stop here means no Overlay code is written and the owner is asked again.
|
||||
|
||||
### The leg with a sleep — results
|
||||
|
||||
Three runs of `fl-probe-reflex --real 10` on 2026-11-13 (RTX 5080, driver 32.0.16.2114), the leg after R5.
|
||||
**No stop condition fired.**
|
||||
|
||||
| # | What was seen | Reading |
|
||||
|---|---|---|
|
||||
| S1 | `SetSleepMode` returned OK in all three runs. A frame then took 4 159 µs (the interval asked for is 4 166), 4 037–4 041 of them inside `NvAPI_D3D_Sleep`; no sleep error. The sleep status afterwards: interval 4 166 µs, `bUseGameSleep` 1 — and **`bLowLatencyMode` 0**, although the mode was set with it on. | The sleep was exercised: the thread stood inside it 97 % of the time. **The status's low-latency field is not the flag the game set**, on this driver; why is not known. It is shown as the driver's word, never as "the game switched Reflex on". |
|
||||
| S2 | One `GetLatency` after each of 2000 sleeping frames, on the thread that sleeps and presents: median **2.5 / 2.6 / 2.6 µs**, mean 2.7–2.8, worst 66.9 / 16.8 / 8.0 µs, none of 2 ms. Back to back: median 0.7 µs (worst 10.2 / 81.6 / 4.1); `GetSleepStatus` median 0.2 µs. | Far inside both limits. A read after a frame that slept costs four or five times a read made back to back — a cold cache, by the look of it — and that is the Overlay's case: **about 2.6 µs, once a second**. |
|
||||
| S3 | From another thread while the first slept and presented at 240 frames a second. Four reads a second for 20 s: 80 reads a run, none not OK, none faulted, worst 64 / 82 / 12 µs (the control before the sleep mode: 92 / 209 / 119 µs). Without a pause for 10 s: **10.26 / 10.26 / 10.43 million reads**, none not OK, none faulted, worst 442 / 635 / 286 µs, **none of a millisecond** (the control: 9.97 / 9.94 / 9.89 million, worst 1 605 / 1 390 / 203 µs, one read of a millisecond in two of the three runs). | **The getter does not wait behind the sleep.** Thirty-one million reads were made while another thread was inside the sleep nearly all the time, and none took a millisecond; the slow reads there are belong to the control. |
|
||||
| S4 | The report: sixty-four frames with content. `driverStartTime` is filled in all sixty-four — it was zero in M5, without a sleep mode; `inputSampleTime` in none (the probe sets no input marker). Simulation start to present end 102–151 µs, to GPU end 150–191 µs; `gpuActiveRenderTimeUs` 0. | With a sleep mode the driver span is reported. A reader that treats a zero end point as "span not reported" covers both shapes. |
|
||||
|
||||
**What it does not say**: a game's own sleep, on a game's own threads, with a real frame's work between the sleep
|
||||
and the present; frame generation's pacer; another driver. Those are what the first real title is for (D136).
|
||||
|
||||
### What moving the sequence into the Overlay found (2026-11-13, the same evening)
|
||||
|
||||
The call sequence became `FrameLedger.Overlay/include/fl_reflex.h`, with one check the candidate did not have: that
|
||||
the two addresses the module answers with are code of the module. **Run against the installed driver, that check
|
||||
refused the driver.** `C:\Windows\System32\nvapi64.dll` is a shim: it answers both ids with addresses inside
|
||||
`nvapi64_impl.dll`, in the driver's own store (`…\DriverStore\FileRepository\nv_dispi.inf_amd64_…`), an image of
|
||||
its own. Three consequences, all in the header now:
|
||||
|
||||
- An address is accepted when it is **executable code of an image the process has loaded** — which still refuses
|
||||
the heap, a stack and nowhere — not only when it is inside `nvapi64.dll`.
|
||||
- **A reference is kept on that image too.** The addresses are code only while `nvapi64_impl.dll` stays loaded, and
|
||||
what the shim does with it when a game unloads NVAPI was not looked at.
|
||||
- **The note above was wrong about Control Flow Guard.** It reasoned from `nvapi64.dll`, which is not a CFG image;
|
||||
the code that is called is in `nvapi64_impl.dll`, which is one (`dumpbin`: instrumented, a function table of
|
||||
5 332 entries). The probe enforces CFG and has made the calls from the shipped header, so on this driver the two
|
||||
getters are valid targets. A game that enforces CFG, on a driver the probe was not run against, is not covered:
|
||||
a target that were not valid is a fast-fail no guard catches.
|
||||
|
||||
The stand-in module answers with addresses of its own, which is why the stub leg could not find this; only the
|
||||
real run could. The probe's `--real` now prints the image each address lies in.
|
||||
|
||||
### A run on a busy PC, and what it says about the 2 ms latch (D141)
|
||||
|
||||
The run that confirmed the corrected header (`Resolve` OK, the reads as before) was made while a native build and an
|
||||
injected test ran on the same PC — the probe's own loop made 9 000 frames a second where it had made 16 000. It is
|
||||
the only run so far that was not alone, and it is the nearer one to a game:
|
||||
|
||||
| | Alone (three runs) | Busy (one run) |
|
||||
|---|---|---|
|
||||
| `GetLatency` after a sleeping frame, on the thread that sleeps and presents (2000 reads) | median 2.5–2.6 µs, worst 8–67 µs | median 3.4 µs, worst 130 µs, none of 2 ms |
|
||||
| From another thread without a pause, while the first sleeps: reads of 1 ms or more / of 2 ms or more | 0 / 0 in 10.3 million | **536 / 25 in 2.9 million**, worst 3.5 ms |
|
||||
| The same before the sleep mode was set | 1 / 0 in 9.9 million | 6 / 2 in 3.2 million, worst 2.2 ms |
|
||||
| Four reads a second for 20 s | worst 12–82 µs | worst 110 µs, none of 1 ms |
|
||||
|
||||
**A reading, not a measurement of a game**: a thread that does nothing but call is taken off its processor now and
|
||||
then on a busy PC, and a read that was under way then is as long as the pause. Twenty-five such pauses of 2 ms or
|
||||
more in ten seconds of calling is 2.5 a second; a read of 3 µs made once a second is inside one of them about once
|
||||
in a hundred thousand reads. **So the latch of D141 will, on a busy PC, sometimes switch the read off for a pause
|
||||
that was Windows' and not the driver's** — of the order of a few sessions in a hundred, for sessions of two hours,
|
||||
if a game's presenting thread is paused as often as this probe's poller was; a presenting thread usually is not.
|
||||
The session then says *stopped: slow* with the microseconds, and the next start of the game reads again. That is the
|
||||
trade the owner chose with D141 (one call, not two): it errs towards the game. The number published with the state
|
||||
is what tells the two apart afterwards — a driver that holds a call does it again and for longer; a pause is a few
|
||||
milliseconds, once.
|
||||
|
||||
**The owner was asked again with this table in hand and kept D141 as it is: one call** (2026-11-13).
|
||||
|
||||
### The first real game (2026-11-14, 0.1.0-beta.47, the owner's sessions 208–210)
|
||||
|
||||
Phantom Blade Zero, Direct3D 12, three sessions — frame generation ×3, then off twice. What only a game could say,
|
||||
and now has for one title on this driver:
|
||||
|
||||
- **The game's own device is the one the driver takes**, and `nvapi64.dll` is findable by name in a game that uses
|
||||
Reflex through Streamline: resolved four to five seconds after the attach, the shim in System32 and the getters
|
||||
in `nvapi64_impl.dll`.
|
||||
- **No latch fired in 1 515 seconds of reading**: the slowest call was 24, 20 and 45 µs, under a game's real load
|
||||
and with frame generation's pacer running. The busy-PC reading above put a false latch at a few sessions in a
|
||||
hundred at worst; three sessions cannot confirm or deny that.
|
||||
- **The report is real**: with frame generation ×3 the total is 23 ms; without it, 5.4 ms at 149 presents a second
|
||||
and 15.9 ms at 67. `inputSampleTime` is not read; `driverStartTime` is reported (the driver series has points).
|
||||
- **The sleep status' low-latency switch reads on in a game** (on at times, off at others) — it never did for the
|
||||
probe. And the driver's `fgMultiplier` read 3 in the session FrameLedger measured at ×3.0.
|
||||
- **`gpuRenderStartTime` lies before `simStartTime` in this game**: start to end is 16.4 ms where simulation start
|
||||
to GPU end is 5.4 ms. The span includes whatever the GPU did before this frame's simulation began — it reads
|
||||
like the interval between two frames' GPU ends. The header's `gpuActiveRenderTimeUs` is the active time and is
|
||||
not read by FrameLedger. The probe could not show this: its frames have no GPU work to speak of.
|
||||
|
||||
Not said by these sessions: ~~Cyberpunk 2077 (REDengine's own NVAPI use)~~, a game that enforces Control Flow
|
||||
Guard, another driver, and whether the player feels the read.
|
||||
|
||||
**Cyberpunk 2077, the same morning (sessions 211 and 212).** Frame generation ×2 for 105 s of the first, off in
|
||||
the second at 238 FPS. Read in both; the slowest call 34 and 65 µs; a report in 97 % and 98 % of the samples.
|
||||
|
||||
- **The spans are sane there**: total 11.7 ms at 238 FPS, GPU render 2.7 ms, never longer than the total (0 of
|
||||
429 samples). With frames generated the total is 13.5 ms; in the menus 4.1 ms. So `gpuRenderStartTime` before
|
||||
`simStartTime` is Phantom Blade Zero's, where *GPU render* sits at 16.4 ms whether the game presents 149 or 67
|
||||
times a second.
|
||||
- **`fgMultiplier` read 1 in the session that generated ×2**: the word carries the last value, and the session
|
||||
ended in a menu. The table needs the values seen, not the last one.
|
||||
- **Samples are 1.32 s apart** (the Agent's `t_ms`), reads one second apart: a read is not always the one sampled.
|
||||
- **Left alone as designed**: two Direct3D 11 games (state 1, one line) and a Direct3D 12 game that never loaded
|
||||
`nvapi64.dll` (state 2, said once, asked again each second without a line).
|
||||
|
||||
**The owner's ruling on the span (2026-11-14): read the driver's active time** — `gpuActiveRenderTimeUs`, which
|
||||
the header defines as the same interval "excluding the idles in between", and with it `gpuFrameTimeUs`. Both are
|
||||
members of the report already fetched.
|
||||
@@ -20,9 +20,9 @@ The link under them, *Read what the hook does and does not do*, opens the safety
|
||||
| Setting | What it does | Default |
|
||||
|---|---|---|
|
||||
| **Minimum session length (s)** | A shorter session is not kept. 5 to 600 seconds. *Agent.* | 30 |
|
||||
| **Sensor interval (ms)** | How often the PC's sensors are read during a session. 500 to 2000 ms. *Agent.* | 1000 |
|
||||
| **Sensor interval (ms)** | How often the PC's sensors are read during a session. 500 to 2000 ms. With a value above 1000, not every reading of NVIDIA's latency report — made about once a second inside the game — becomes a point: each point is still one reading ([Advanced metrics](12-advanced-metrics.md)). *Agent.* | 1000 |
|
||||
| **Raw series kept per game** | How many of each game's newest sessions keep their per-frame data; older ones keep their statistics. 0 keeps everything. *Agent.* | 20 |
|
||||
| **Advanced metrics** | Reads more from the graphics driver and the hardware sensors during a session — the graphics card's memory and load in detail, each fan and voltage, what your display can do, the driver's settings for the game — and stores it with the session. Off: nothing more is read or stored. It applies from the next session; a session recorded while it was off is not filled in later. While it is on, the **Advanced** page is in the list on the left ([Advanced metrics](12-advanced-metrics.md)). *Agent.* | Off |
|
||||
| **Advanced metrics** | Reads more from the graphics driver and the hardware sensors during a session — the graphics card's memory and load in detail, each fan and voltage, what your display can do, the driver's settings for the game — and stores it with the session. In a game FrameLedger measures from inside it also reads what the game tells DLSS, Streamline and FSR, and — on an NVIDIA card, in a Direct3D 12 game that uses NVIDIA's library — asks the graphics driver about once a second how long each stage of a frame took ([Advanced metrics](12-advanced-metrics.md)). Off: nothing more is read or stored. It applies from the next session; a session recorded while it was off is not filled in later. While it is on, the **Advanced** page is in the list on the left ([Advanced metrics](12-advanced-metrics.md)). *Agent.* | Off |
|
||||
|
||||
## Data
|
||||
|
||||
|
||||
@@ -71,6 +71,8 @@ also keeps what the game itself handed to DLSS and FSR:
|
||||
*off* or *on and off* during the session; `· slAllocateResources` and `· slFreeResources` count how many times it
|
||||
set up and released what the feature needs (up to 15, then `≥ 15`); `slShutdown` counts how many times it shut
|
||||
Streamline down. These begin when FrameLedger is in the game: what the game did while it started is not there.
|
||||
In the games run so far every one asks whether its features are supported; the other rows appear in some games
|
||||
and not in others, and no game has shown an allocation.
|
||||
|
||||
These are the game's own words to the upscaler, shown in the vendor's notation (`preExposure`, preset `K`).
|
||||
FrameLedger does not check what the upscaler did with them.
|
||||
@@ -81,6 +83,51 @@ the session says, for each call, whether it was *read*, *hooked — the game did
|
||||
the game did not load the library that has the call*; the six calls of 0.1.0-beta.45 are named in one sentence,
|
||||
under which of the three happened to each.
|
||||
|
||||
### What NVIDIA's driver says about each frame's stages
|
||||
|
||||
On an NVIDIA card, in a **Direct3D 12** game that has **NVIDIA Reflex** built in, a session with Advanced metrics
|
||||
on also stores the driver's own latency report — whether Reflex is on or off in the game's menu, because a game
|
||||
with Reflex marks its frames either way: how long the driver says each stage of a frame took — *simulation*,
|
||||
*render submit*, *present*, *driver*, *operating system's render queue*, *GPU render*, and the *total* from the start
|
||||
of simulation to the end of the graphics card's work. They are seven lines under **Latency**, one point about every
|
||||
second, each the average of the frames of one reading, in microseconds. A table beside them shows the driver's
|
||||
low-latency state as five switches, by NVIDIA's own names, each *On*, *Off* or *On at times, off at others*, and
|
||||
`fgMultiplier`: every frame-generation multiplier the driver gave during the session (*1, 2* is a session that
|
||||
generated frames at ×2 for part of it). **They are the driver's switches, not the game's menu.** `bLowLatencyMode`
|
||||
is on when the game switched Reflex on *and* when **Low Latency Mode** is set for that game in the NVIDIA App —
|
||||
an override there shows here, and can read *On at times, off at others* in a game whose own setting never
|
||||
changed. `bUseGameSleep` says whether the game calls Reflex's sleep each frame. NVIDIA asks games to call it even
|
||||
while Reflex is off, so *On* there does not say Reflex is on — `bLowLatencyMode` does; some games call it only
|
||||
while frame generation is on. Frame generation needs Reflex and not the other way round: the mode can be on
|
||||
with `fgMultiplier` at 1.
|
||||
|
||||
**The stages overlap; they are not parts that add up to the total.** And *GPU render* is the time between two
|
||||
marks the driver sets, at the start and at the end of the card's work on a frame: where the card waits between
|
||||
pieces of work, the waiting is in it — in one game it is longer than the whole frame. So a second chart, **the
|
||||
graphics card's time per frame, as the driver works it out**, has two lines of the driver's own figures: *GPU
|
||||
active render*, how long the driver says the card worked on the frame, and *GPU frame time*, from the end of one
|
||||
frame's work to the end of the next. **The active time is usually the shorter of the two, and not always**: in
|
||||
Cyberpunk 2077 without frame generation it is about a fifth longer than the two marks are apart, frame after
|
||||
frame — the driver counts work its marks do not enclose. Both are shown as the driver gives them. A driver may
|
||||
give neither; the chart is then not there, and nothing is wrong.
|
||||
|
||||
Three things to know about them:
|
||||
|
||||
- **They are the driver's numbers, not FrameLedger's.** FrameLedger does not measure these stages; it stores what
|
||||
the driver reports and has not checked it against another tool. They are not the delay from a click to the screen.
|
||||
- **FrameLedger asks for them from inside the game**, about once a second — the one thing it does in a game that is
|
||||
not reading what the game itself passes along. It asks only through NVIDIA's library where the game had already
|
||||
loaded it, and never loads that library itself. A copy of the library sitting in the game's own folder (some
|
||||
mods put one there) is not the driver's, and FrameLedger does not use it.
|
||||
- **It switches itself off rather than disturb the game.** If one request takes two thousandths of a second or
|
||||
more, or goes wrong, FrameLedger makes no further request until the game is closed. The line under the session
|
||||
then says *stopped*, and why; the next time the game starts it reads again. On a busy PC this can happen for a
|
||||
pause that was Windows' and not the driver's.
|
||||
|
||||
The line under the session says what happened: *read*; *asked, and the driver reported no frame* (the game does not
|
||||
use Reflex); *not read* with the reason — the game does not present through Direct3D 12, it has not loaded NVIDIA's
|
||||
library, or that library is in the game's own folder; or *stopped*.
|
||||
|
||||
**Many games will show nothing here**, and the line under the session says why: *the game made none of the calls
|
||||
these are read from* — most games set their DLSS options through a call FrameLedger cannot see, and only games that
|
||||
use FSR 3.1 or later through AMD's own library show the FSR rows — or *the session was not measured inside the game*.
|
||||
@@ -108,7 +155,14 @@ comes from, and whether it is read. Where it is not, the reason is written out:
|
||||
administrator*);
|
||||
- **not present on this PC** — the driver's own figures exist on NVIDIA cards only;
|
||||
- **read inside a game FrameLedger measures, when the game makes the call** — what the game tells DLSS and FSR
|
||||
(above). Some further readings inside the game **come with a later release**;
|
||||
(above);
|
||||
- **read inside a game FrameLedger measures, from the graphics driver** — NVIDIA's latency report (above);
|
||||
- **not read: it would take a patch at an address found while the game runs, a function of FrameLedger's handed
|
||||
to the game in place of the vendor's, or a call the vendor forbids from outside the game's own threads** — what
|
||||
the game asked of Reflex, Reflex's state through Streamline, and what a game sets and asks through Streamline's
|
||||
own functions for a feature: DLSS frame generation's options and state, the video memory DLSS estimates for
|
||||
itself, and the options of ray reconstruction, Image Scaling and Dynamic Vibrance. No later release will read
|
||||
these;
|
||||
- **the game makes this call once, before FrameLedger is inside it** — what the game started Streamline with. It is
|
||||
not read, and no later release will read it;
|
||||
- **never read** — a serial number, a display's identification data, which other programs are encoding, the camera's
|
||||
|
||||
+16
-5
@@ -12,7 +12,7 @@
|
||||
HTML comments are not part of the block.
|
||||
-->
|
||||
> ⚠ **What FrameLedger actually measures today — 2026-11-11.** The software is a beta; its latest
|
||||
> **beta is `0.1.0-beta.45`** (2026-11-12), an unsigned installer built from that tag with its
|
||||
> **beta is `0.1.0-beta.49`** (2026-11-14), an unsigned installer built from that tag with its
|
||||
> checksums published beside it (alphas — experimental builds that try a newer .NET — are published apart). The source holds the desktop app
|
||||
> (library, store import, charts, settings) and the background Agent, which records a session when a
|
||||
> game in the library runs (unless you switched its recording off), injects only into games you enabled
|
||||
@@ -86,8 +86,18 @@
|
||||
> mean, median and peak. The game's other processes (launchers, helpers) are not counted.
|
||||
> - **Video memory:** in use on the whole graphics card, recorded from Windows and GPU-driver telemetry
|
||||
> and charted. **Not measured at all:** the video-memory budget Windows gives a game, which frame
|
||||
> spikes were shader compilation, PC latency (Reflex), and HDR. Stutter count and stutter time are
|
||||
> spikes were shader compilation, end-to-end PC latency, and HDR. Stutter count and stutter time are
|
||||
> measured from frame times.
|
||||
> - **NVIDIA's latency report (only with Advanced metrics on; Direct3D 12; a game that uses NVIDIA Reflex):** how
|
||||
> long the driver says each stage of a frame took — simulation, render submit, present, driver, the operating
|
||||
> system's queue, the graphics card — read from the graphics driver about once a second and shown as the driver
|
||||
> reported it: **the driver's numbers, not a measurement by FrameLedger**, an average of the frames of one read,
|
||||
> never checked against another tool, and not the delay from a click to the screen. **The stages overlap and do
|
||||
> not add up to the total.** The graphics card's stage runs from its start to its end and includes the time the
|
||||
> card waited — in one game it was longer than the whole frame — so since beta.48 two figures the driver works
|
||||
> out itself are shown beside it: the card's active time, and the time from one frame's end to the next. A
|
||||
> driver may give neither, and then there is no line. Read in two real games, on one driver and one card
|
||||
> (2026-11-14). A game that does not use Reflex has none. The session summary's latency fields stay N/A.
|
||||
> - **Pacing, VSync and the graphics card (since beta.14):** the share of the time below 30 FPS, below 60 FPS and below
|
||||
> the monitor's refresh rate, measured from frame times with small margins so that a game held at its limit is not
|
||||
> counted as below it (a rate less than 2 % under the line reads partly as at it), and how much one frame's time
|
||||
@@ -123,9 +133,10 @@
|
||||
> also whether Streamline says each feature is supported and whether it is loaded, and what the game did with it
|
||||
> after FrameLedger attached — switched it on or off, allocated and freed its resources (counted to fifteen), shut
|
||||
> Streamline down: calls the game made, not a statement that a feature ran or produced anything. FSR's upscaling
|
||||
> values, Streamline's constants (six games), its answers about a feature (five games) and the
|
||||
> frame-generation configuration (one game) have been read from real games; the DLSS options and the six calls
|
||||
> of beta.45 have not been confirmed on one yet. A game may give a value in a unit of its own: one gives
|
||||
> values, Streamline's constants (seven games), its answers about a feature (seven games), the
|
||||
> frame-generation configuration (one game) and five of beta.45's six calls (five games) have been read from
|
||||
> real games; no game run so far allocated a feature's resources after FrameLedger attached, and the DLSS
|
||||
> options have not been confirmed on one yet. A game may give a value in a unit of its own: one gives
|
||||
> Streamline its field of view in degrees, and it is shown as given.
|
||||
> - **Safety:** every pre-injection check runs before injection, including the signed-by-a-known-vendor
|
||||
> half of the suspicious-module rule. During every capture the Agent re-runs the checks every 30 s and
|
||||
|
||||
+24
-9
@@ -1,6 +1,6 @@
|
||||
# FrameLedger — Disclaimer
|
||||
|
||||
**Version:** 2.15 · **Effective:** {{RELEASE_DATE}}
|
||||
**Version:** 2.17 · **Effective:** {{RELEASE_DATE}}
|
||||
|
||||
## 0. This is pre-release software
|
||||
|
||||
@@ -43,11 +43,11 @@ Be precise about what that does and does not promise, because the shorter versio
|
||||
|
||||
Install it somewhere only you can write to, and verify the published SHA-256 checksums.
|
||||
|
||||
**What it observes inside the game:** arguments the game passes to graphics APIs we intercept (presentation, upscaling, ray tracing, pipeline creation).
|
||||
**What it observes inside the game:** arguments the game passes to graphics APIs we intercept (presentation, upscaling, ray tracing, pipeline creation) — and, only while Advanced metrics is on, one thing that is not an argument: the graphics driver's own report of how long the stages of the game's last frames took, which the component asks NVIDIA's driver for itself (§2 says exactly how).
|
||||
|
||||
**What it reads about the game from outside it, in every session:** the game process's own memory use — its dedicated and shared video memory and its working sets, the figures Windows' Task Manager shows — from Windows' performance counters and process-memory information. For a game it does not inject into, FrameLedger opens the game's process for this with the least access Windows offers, once a second, and closes it again; it reads nothing inside the process.
|
||||
|
||||
> **What of that list is observed today is stated once, in §4 below** (the block `legal/ACCURACY.md` carries, dated). The list here describes what the software is designed to observe, and the boundary — API arguments and nothing else — holds for all of it.
|
||||
> **What of that list is observed today is stated once, in §4 below** (the block `legal/ACCURACY.md` carries, dated). The list here describes what the software is designed to observe, and the boundary — API arguments, and the one report asked of the graphics driver that the line above names; nothing of the game's own memory — holds for all of it.
|
||||
|
||||
**What it never does:** read or write the game's memory outside those API arguments; read save files, input, chat, or network traffic; modify game behavior; hide itself from any security software; or install a kernel driver of its own.
|
||||
|
||||
@@ -72,7 +72,11 @@ FrameLedger is designed to reduce that risk substantially:
|
||||
the game exits.
|
||||
- FrameLedger contains **no evasion techniques of any kind** — it does not hide, rename, obfuscate, or disguise itself. It is intended to be plainly identifiable to any security software that looks.
|
||||
|
||||
For completeness about what it *does* run inside the game: besides the intercepted calls themselves, the component starts **one background thread**. It wakes once a second, or when the game loads a library, and then: checks FrameLedger's own shared memory for a request to stop and for the heartbeat of the safety scan described above; asks Windows, by name, whether the graphics, upscaling and frame-generation libraries it knows about are loaded, and puts its interception into the ones that are (for ray tracing it creates one command list on the game's own Direct3D 12 device, to find the functions to intercept); writes its counters to FrameLedger's shared memory; and writes FrameLedger's own log file. It does not scan the game's memory, list the modules or processes on the system, or query Windows services — deliberately, because software that does those things from inside a game process looks like the thing this tool is trying not to be mistaken for.
|
||||
For completeness about what it *does* run inside the game: besides the intercepted calls themselves, the component starts **one background thread**. It wakes once a second, or when the game loads a library, and then: checks FrameLedger's own shared memory for a request to stop and for the heartbeat of the safety scan described above; asks Windows, by name, whether the graphics, upscaling and frame-generation libraries it knows about are loaded, and puts its interception into the ones that are (for ray tracing it creates one command list on the game's own Direct3D 12 device, to find the functions to intercept); writes its counters to FrameLedger's shared memory; and writes FrameLedger's own log file.
|
||||
|
||||
**One call it makes itself, into the graphics driver — only while Advanced metrics is on.** In a Direct3D 12 game that had already loaded NVIDIA's driver library (`nvapi64.dll`), the component asks that library — by name, among what the game loaded; it never loads it — for two of the driver's read-only functions, and keeps the library and the driver file those functions are in from being unloaded for as long as the game runs. Then, about once a second, **on the game's own thread that presents its frames**, right after a frame has been handed over, it calls them: one returns the driver's report of how long the stages of the last frames took, the other the driver's low-latency state. It calls no function that sets, marks or delays anything. A library of that name sitting in the game's own folder is not the driver's and is not called. What this costs the game is the length of that call, once a second — a few millionths of a second where it was measured. A call that faults is caught, counted once, and not repeated; a call that takes two thousandths of a second or more is the last one until the game is closed. **A call that never returns would hold the game's presenting thread, and FrameLedger cannot stop it** — it has not happened in any test, and it is said here because it is the one thing in this component whose length FrameLedger's own code does not bound. With Advanced metrics off — the default — none of this happens.
|
||||
|
||||
It does not scan the game's memory, list the modules or processes on the system, or query Windows services — deliberately, because software that does those things from inside a game process looks like the thing this tool is trying not to be mistaken for.
|
||||
- FrameLedger injects into a game only after you enable that game individually. For every other game — and for any game where the safety checks refuse — it records the session's start, end and duration together with whatever hardware sensor readings your machine provides and the game's own memory use as Windows reports it (§1), and reports every other measurement as not available. **There is no measurement mode that works without injecting**; an earlier version of this document described one, and it was never built. FrameLedger never estimates a value it could not measure, and it always shows which of the two modes produced a session. Neither mode requires administrator rights.
|
||||
|
||||
**However, these protections cannot be complete:**
|
||||
@@ -121,7 +125,7 @@ Frame timing is derived from high-resolution timestamps taken at the moment the
|
||||
|
||||
<!-- accuracy-block:begin -->
|
||||
> ⚠ **What FrameLedger actually measures today — 2026-11-11.** The software is a beta; its latest
|
||||
> **beta is `0.1.0-beta.45`** (2026-11-12), an unsigned installer built from that tag with its
|
||||
> **beta is `0.1.0-beta.49`** (2026-11-14), an unsigned installer built from that tag with its
|
||||
> checksums published beside it (alphas — experimental builds that try a newer .NET — are published apart). The source holds the desktop app
|
||||
> (library, store import, charts, settings) and the background Agent, which records a session when a
|
||||
> game in the library runs (unless you switched its recording off), injects only into games you enabled
|
||||
@@ -195,8 +199,18 @@ Frame timing is derived from high-resolution timestamps taken at the moment the
|
||||
> mean, median and peak. The game's other processes (launchers, helpers) are not counted.
|
||||
> - **Video memory:** in use on the whole graphics card, recorded from Windows and GPU-driver telemetry
|
||||
> and charted. **Not measured at all:** the video-memory budget Windows gives a game, which frame
|
||||
> spikes were shader compilation, PC latency (Reflex), and HDR. Stutter count and stutter time are
|
||||
> spikes were shader compilation, end-to-end PC latency, and HDR. Stutter count and stutter time are
|
||||
> measured from frame times.
|
||||
> - **NVIDIA's latency report (only with Advanced metrics on; Direct3D 12; a game that uses NVIDIA Reflex):** how
|
||||
> long the driver says each stage of a frame took — simulation, render submit, present, driver, the operating
|
||||
> system's queue, the graphics card — read from the graphics driver about once a second and shown as the driver
|
||||
> reported it: **the driver's numbers, not a measurement by FrameLedger**, an average of the frames of one read,
|
||||
> never checked against another tool, and not the delay from a click to the screen. **The stages overlap and do
|
||||
> not add up to the total.** The graphics card's stage runs from its start to its end and includes the time the
|
||||
> card waited — in one game it was longer than the whole frame — so since beta.48 two figures the driver works
|
||||
> out itself are shown beside it: the card's active time, and the time from one frame's end to the next. A
|
||||
> driver may give neither, and then there is no line. Read in two real games, on one driver and one card
|
||||
> (2026-11-14). A game that does not use Reflex has none. The session summary's latency fields stay N/A.
|
||||
> - **Pacing, VSync and the graphics card (since beta.14):** the share of the time below 30 FPS, below 60 FPS and below
|
||||
> the monitor's refresh rate, measured from frame times with small margins so that a game held at its limit is not
|
||||
> counted as below it (a rate less than 2 % under the line reads partly as at it), and how much one frame's time
|
||||
@@ -232,9 +246,10 @@ Frame timing is derived from high-resolution timestamps taken at the moment the
|
||||
> also whether Streamline says each feature is supported and whether it is loaded, and what the game did with it
|
||||
> after FrameLedger attached — switched it on or off, allocated and freed its resources (counted to fifteen), shut
|
||||
> Streamline down: calls the game made, not a statement that a feature ran or produced anything. FSR's upscaling
|
||||
> values, Streamline's constants (six games), its answers about a feature (five games) and the
|
||||
> frame-generation configuration (one game) have been read from real games; the DLSS options and the six calls
|
||||
> of beta.45 have not been confirmed on one yet. A game may give a value in a unit of its own: one gives
|
||||
> values, Streamline's constants (seven games), its answers about a feature (seven games), the
|
||||
> frame-generation configuration (one game) and five of beta.45's six calls (five games) have been read from
|
||||
> real games; no game run so far allocated a feature's resources after FrameLedger attached, and the DLSS
|
||||
> options have not been confirmed on one yet. A game may give a value in a unit of its own: one gives
|
||||
> Streamline its field of view in degrees, and it is shown as given.
|
||||
> - **Safety:** every pre-injection check runs before injection, including the signed-by-a-known-vendor
|
||||
> half of the suspicious-module rule. During every capture the Agent re-runs the checks every 30 s and
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# FrameLedger — Privacy Policy
|
||||
|
||||
**Version:** 2.19 · **Effective:** {{RELEASE_DATE}}
|
||||
**Version:** 2.21 · **Effective:** {{RELEASE_DATE}}
|
||||
|
||||
**Short version: everything stays on your PC. FrameLedger has no accounts, no telemetry, no analytics, and never uploads your data anywhere.**
|
||||
|
||||
@@ -11,7 +11,7 @@ Stored in `%LOCALAPPDATA%\FrameLedger` on your device:
|
||||
- Your game library entries (names, executable paths, metadata you or the app filled in, and whether each one is recorded).
|
||||
- Images you choose for a game (Edit…), copied into the `covers` folder; choosing the store's image again, or removing the game together with its sessions, deletes the copy. Artwork a store's app keeps on your PC, or a game ships in its own folder, is shown from where it is and not copied.
|
||||
- Performance sessions: frame timing series, computed statistics, hardware sensor series (temperatures, load, power, memory usage, and the graphics card's clock speeds, fan speed, memory temperature and whether its power limit or heat held it back), the game's own memory use (its dedicated and shared video memory, private working set, working set and commit, once a second), session duration, crash flags, the graphics driver's settings the game ran under (NVIDIA only), how the game's window was shown (full-screen, borderless or windowed, for how long, its size and the monitor's), tags and notes you write.
|
||||
- **Only while Settings ▸ Advanced metrics is on** (it is off unless you switch it on), with each session: more hardware sensor series — the graphics card's memory use in detail, its load by part, its clocks, voltages, currents, power, each fan and its video encoder's use; and, when the capture agent runs as administrator with PawnIO installed, the processor's temperatures, load, clocks, power and voltages by core, the memory in use and its modules' temperatures, and the motherboard's temperatures, fans and voltages — and a description of the hardware: the graphics card's firmware version, architecture, bus and memory sizes, the graphics driver's package and the chipset it names, the motherboard's and the memory modules' model names, what each connected display can do (the HDR formats it accepts, its brightness range, variable refresh), whether variable refresh was in use on the display the game ran on and the colour space the game presented in, and the graphics driver's settings — its global ones and the ones it holds for the game (NVIDIA only). For a game FrameLedger injects into, a session then also stores what the game itself passed to its upscaler in the calls FrameLedger intercepts: the output size, the model presets and the exposure values it gave DLSS, whether it said its colour buffers are HDR, auto-exposure and alpha upscaling; and the sharpening, the size of the jitter, the exposure, the depth range, the lowest and highest field of view and the flags it gave FSR, the frame time it reported to FSR, and FSR's own video memory when the game asked for it; what the game told NVIDIA Streamline about each frame — the size of the jitter, the motion-vector scale, the depth range and whether depth is inverted, the lowest and highest field of view, the aspect ratio, whether the projection is orthographic, how its motion vectors are stored and how often it reset the upscaler's history; and how it configured FSR frame generation — on or off, whether it may run asynchronously, its flags, whether only generated frames are presented, and the rectangle it generates in; and what NVIDIA Streamline answered when the game asked it about a feature — which features the game asked about, the version of each and of its NGX model, and what each requires: the graphics APIs it supports, whether V-Sync must be off and hardware-accelerated GPU scheduling on, how many processor threads, viewports and buffers, and the versions of Windows and of the graphics driver that Streamline found beside the ones the feature needs ; and, for each Streamline feature the game asks about or controls: whether Streamline answers that it is supported, whether it is loaded, whether the game switched it on or off while it ran, and how many times its resources were allocated and freed; and whether the game shut Streamline down, and how many times — never the lists Streamline's answer points to (the buffers' names, the names of Vulkan extensions and features), never what identifies the graphics card that the game hands over with its question, never the content of a graphics resource, and never where the game's camera is, which way it looks, or its matrices. No serial number, no display identification data (EDID) and no list of other programs is read or stored. Switching the option off stops the reading, inside a game as well; what earlier sessions stored stays with them until you delete those sessions.
|
||||
- **Only while Settings ▸ Advanced metrics is on** (it is off unless you switch it on), with each session: more hardware sensor series — the graphics card's memory use in detail, its load by part, its clocks, voltages, currents, power, each fan and its video encoder's use; and, when the capture agent runs as administrator with PawnIO installed, the processor's temperatures, load, clocks, power and voltages by core, the memory in use and its modules' temperatures, and the motherboard's temperatures, fans and voltages — and a description of the hardware: the graphics card's firmware version, architecture, bus and memory sizes, the graphics driver's package and the chipset it names, the motherboard's and the memory modules' model names, what each connected display can do (the HDR formats it accepts, its brightness range, variable refresh), whether variable refresh was in use on the display the game ran on and the colour space the game presented in, and the graphics driver's settings — its global ones and the ones it holds for the game (NVIDIA only). For a game FrameLedger injects into, a session then also stores what the game itself passed to its upscaler in the calls FrameLedger intercepts: the output size, the model presets and the exposure values it gave DLSS, whether it said its colour buffers are HDR, auto-exposure and alpha upscaling; and the sharpening, the size of the jitter, the exposure, the depth range, the lowest and highest field of view and the flags it gave FSR, the frame time it reported to FSR, and FSR's own video memory when the game asked for it; what the game told NVIDIA Streamline about each frame — the size of the jitter, the motion-vector scale, the depth range and whether depth is inverted, the lowest and highest field of view, the aspect ratio, whether the projection is orthographic, how its motion vectors are stored and how often it reset the upscaler's history; and how it configured FSR frame generation — on or off, whether it may run asynchronously, its flags, whether only generated frames are presented, and the rectangle it generates in; and what NVIDIA Streamline answered when the game asked it about a feature — which features the game asked about, the version of each and of its NGX model, and what each requires: the graphics APIs it supports, whether V-Sync must be off and hardware-accelerated GPU scheduling on, how many processor threads, viewports and buffers, and the versions of Windows and of the graphics driver that Streamline found beside the ones the feature needs ; and, for each Streamline feature the game asks about or controls: whether Streamline answers that it is supported, whether it is loaded, whether the game switched it on or off while it ran, and how many times its resources were allocated and freed; and whether the game shut Streamline down, and how many times — never the lists Streamline's answer points to (the buffers' names, the names of Vulkan extensions and features), never what identifies the graphics card that the game hands over with its question, never the content of a graphics resource, and never where the game's camera is, which way it looks, or its matrices. For a Direct3D 12 game that had itself loaded NVIDIA's driver library, a session also stores what the graphics driver reports about the game's frames when FrameLedger asks it, about once a second, from inside the game: how long each stage of a frame took — simulation, render submit, present, the driver, the operating system's queue and the graphics card, and the whole from the start of simulation to the end of the graphics card's work — as averages in microseconds, with two figures the driver works out itself (how long the graphics card was actually at work on a frame, and the time from the end of one frame's work to the end of the next), and the driver's low-latency state (five switches it reports, and the frame-generation multipliers it gave during the session) — never a time of day, and never the moment the player pressed anything. No serial number, no display identification data (EDID) and no list of other programs is read or stored. Switching the option off stops the reading, inside a game as well; what earlier sessions stored stays with them until you delete those sessions.
|
||||
- A hardware snapshot per session (CPU/GPU model, driver version, RAM size, OS build, display mode) used for the "what changed between sessions" feature.
|
||||
- App settings, logs (rotated daily — the app keeps 7 days, the capture agent 14 — including the logs written by the component loaded into games), and, after a crash of the app itself, crash dump files.
|
||||
- Which games you enabled code injection for, and when you consented.
|
||||
@@ -43,7 +43,7 @@ An exported session (CSV or JSON) and a bug report can contain your games' names
|
||||
|
||||
## 4. What the app can technically observe
|
||||
|
||||
To do its job, FrameLedger observes: which of *your tracked* executables — the entries in your library whose recording is on — are running, and their process trees; whether a game you enabled hooking for runs in an app container, and which of Windows' code-protection settings it runs under (for example, accepting only Microsoft-signed code), read from Windows before any injection; the parameters your games pass to the graphics APIs it intercepts (presentation, upscaling, ray tracing, pipeline creation) — and, only while Advanced metrics is on, more of the parameters of the upscaling calls, and the parameters of ten further calls it begins to intercept in a game only once a session with that option on has started there (the constants the game gives NVIDIA Streamline for each frame, the game's configuration of FSR frame generation, Streamline's answers to the game's four questions about a feature — which version it is, what it requires, whether it is supported and whether it is loaded — and the game switching a feature on or off, allocating and freeing its resources, and shutting Streamline down), which are then stored with the session (sizes, presets, exposure, sharpening, the jitter's size, the motion-vector scale, the depth range, the range of the field of view, flags, the reported frame time, the upscaler's own memory, how frame generation is configured, the versions and requirements of Streamline's features, whether each is supported and loaded, and how often the game switched it, allocated and freed its resources and shut Streamline down), never the camera's position, direction or matrices, and never what identifies the graphics card; the memory use of a tracked game's process — its dedicated and shared video memory, from Windows' GPU performance counters, and its working sets and commit, from Windows' process-memory information, for which a game it does not inject into is opened with the least access Windows offers and closed again (never its memory's content); loaded module names of a game being captured, the version information of its upscaling, frame-generation and neural-rendering libraries, and whether each was loaded from the game's folder or from the graphics driver's own copy (for detection and for the anti-cheat safety check); the names of the files in each library game's install folder, the version information of its executable and of the upscaling and neural-rendering libraries it ships, the content of its executable file (the markers of the engine and of the graphics libraries it carries, the libraries it imports, and the engine build name an Unreal Engine game carries), the version marks an engine keeps in its own files (Unity's player library and the header of its data file, the header of a Godot data pack, an RPG Maker game's title, core script and Game.ini, the library Game.ini names, and the version file of a Ren'Py game's engine), and the store files that name it (Steam's and GOG's, on your disk) and, for a game the Xbox app or the Microsoft Store installed, the package files in its install folder that describe it (`MicrosoftGame.config` and `appxmanifest.xml`) — to detect its engine, its engine version and its features and to check it for anti-cheat before any injection is possible; the lists of installed games that the Steam, GOG GALAXY, Epic Games and itch apps keep on your disk, and where GOG GALAXY is installed, the folders the Xbox app installs games into on each drive (named by the `.GamingRoot` file at the drive's root) with each game's package files, and Windows' answer to whether that game's package is installed for you — read when you import your library and when you press Play, to find the store that installed a game and hand the game to that store's app — Steam's and GOG GALAXY's also when you open a game's page, to find the artwork their apps keep for it; the cover and banner images that the Steam and GOG GALAXY apps keep on your disk for a game in your library and the logo and splash-screen images a game from the Xbox app ships in its own folder — read to show them on its page, never copied or sent anywhere; the size, position and state of a tracked game's window and the monitor it is on, read from Windows and not from the game, and — for a game FrameLedger injects into — whether the game asked for exclusive full-screen; the NVIDIA driver's settings for your tracked executables (read only: the DLSS and frame-generation overrides the NVIDIA App set); hardware sensor values from your graphics driver's own libraries; and — only while Advanced metrics is on — that driver's description of the graphics card and of each connected display, what it reports about the display a tracked game's window is on, its settings for a tracked game and its global ones (read only), and, when the capture agent runs as administrator with PawnIO installed, the sensors and model names of the processor, the memory and the motherboard (never a drive's), all of which areLine truncated
|
||||
To do its job, FrameLedger observes: which of *your tracked* executables — the entries in your library whose recording is on — are running, and their process trees; whether a game you enabled hooking for runs in an app container, and which of Windows' code-protection settings it runs under (for example, accepting only Microsoft-signed code), read from Windows before any injection; the parameters your games pass to the graphics APIs it intercepts (presentation, upscaling, ray tracing, pipeline creation) — and, only while Advanced metrics is on, more of the parameters of the upscaling calls, and the parameters of ten further calls it begins to intercept in a game only once a session with that option on has started there (the constants the game gives NVIDIA Streamline for each frame, the game's configuration of FSR frame generation, Streamline's answers to the game's four questions about a feature — which version it is, what it requires, whether it is supported and whether it is loaded — and the game switching a feature on or off, allocating and freeing its resources, and shutting Streamline down), which are then stored with the session (sizes, presets, exposure, sharpening, the jitter's size, the motion-vector scale, the depth range, the range of the field of view, flags, the reported frame time, the upscaler's own memory, how frame generation is configured, the versions and requirements of Streamline's features, whether each is supported and loaded, and how often the game switched it, allocated and freed its resources and shut Streamline down), never the camera's position, direction or matrices, and never what identifies the graphics card; and — only while Advanced metrics is on, only in a Direct3D 12 game that had itself loaded NVIDIA's driver library — the graphics driver's own report of the game's last frames and its low-latency state, which the component asks that driver for itself about once a second (it makes that call; the game does not), keeping only how long each stage took; the memory use of a tracked game's process — its dedicated and shared video memory, from Windows' GPU performance counters, and its working sets and commit, from Windows' process-memory information, for which a game it does not inject into is opened with the least access Windows offers and closed again (never its memory's content); loaded module names of a game being captured, the version information of its upscaling, frame-generation and neural-rendering libraries, and whether each was loaded from the game's folder or from the graphics driver's own copy (for detection and for the anti-cheat safety check); the names of the files in each library game's install folder, the version information of its executable and of the upscaling and neural-rendering libraries it ships, the content of its executable file (the markers of the engine and of the graphics libraries it carries, the libraries it imports, and the engine build name an Unreal Engine game carries), the version marks an engine keeps in its own files (Unity's player library and the header of its data file, the header of a Godot data pack, an RPG Maker game's title, core script and Game.ini, the library Game.ini names, and the version file of a Ren'Py game's engine), and the store files that name it (Steam's and GOG's, on your disk) and, for a game the Xbox app or the Microsoft Store installed, the package files in its install folder that describe it (`MicrosoftGame.config` and `appxmanifest.xml`) — to detect its engine, its engine version and its features and to check it for anti-cheat before any injection is possible; the lists of installed games that the Steam, GOG GALAXY, Epic Games and itch apps keep on your disk, and where GOG GALAXY is installed, the folders the Xbox app installs games into on each drive (named by the `.GamingRoot` file at the drive's root) with each game's package files, and Windows' answer to whether that game's package is installed for you — read when you import your library and when you press Play, to find the store that installed a game and hand the game to that store's app — Steam's and GOG GALAXY's also when you open a game's page, to find the artwork their apps keep for it; the cover and banner images that the Steam and GOG GALAXY apps keep on your disk for a game in your library and the logo and splash-screen images a game from the Xbox app ships in its own folder — read to show them on its page, never copied or sent anywhere; the size, position and state of a tracked game's window and the monitor it is on, read from Windows and not from the game, and — for a game FrameLedger injects into — whether the game asked for exclusive full-screen; the NVIDIA driver's settings for your tracked executables (read only: the DLSS and frame-generation overrides the NVIDIA App set); hardware sensor values from your graphics driver's own libraries; and — only while Advanced metrics is on — that driver's description of the graphLine truncated
|
||||
|
||||
It does **not** read game memory outside those API parameters, and does not read game saves, chat, input content, network traffic, or anything unrelated to performance measurement. It records only for programs you added to your library and did not switch recording off for — a program whose recording is off is not watched at all — and injects only into games you individually enabled.
|
||||
|
||||
|
||||
Generated
+72
@@ -193,6 +193,7 @@ public static class Strings
|
||||
nameof(Adv_nvapi_load_video),
|
||||
nameof(Adv_nvapi_pstate),
|
||||
nameof(Adv_nvapi_reflex_frame_report),
|
||||
nameof(Adv_nvapi_reflex_gpu_times),
|
||||
nameof(Adv_nvapi_reflex_mode),
|
||||
nameof(Adv_nvapi_reflex_sleep_status),
|
||||
nameof(Adv_nvapi_session_driver_profile),
|
||||
@@ -263,6 +264,7 @@ public static class Strings
|
||||
nameof(Advanced_Facts_Header),
|
||||
nameof(Advanced_Header),
|
||||
nameof(Advanced_InGameCallsLine),
|
||||
nameof(Advanced_InGameDriverLine),
|
||||
nameof(Advanced_InGameFeatureCallsLine),
|
||||
nameof(Advanced_InGameLine),
|
||||
nameof(Advanced_InGameMoreCallsLine),
|
||||
@@ -286,12 +288,24 @@ public static class Strings
|
||||
nameof(Advanced_State_Viewer),
|
||||
nameof(Advanced_State_Waiting),
|
||||
nameof(Advanced_Status_InGame),
|
||||
nameof(Advanced_Status_InGameDriver),
|
||||
nameof(Advanced_Status_Read),
|
||||
nameof(Advanced_Status_Readable),
|
||||
nameof(Advanced_Status_SourceSilent),
|
||||
nameof(Advanced_Tab_Machine),
|
||||
nameof(Advanced_Tab_Session),
|
||||
nameof(Advanced_Tab_Sources),
|
||||
nameof(AdvDriverRead_Error),
|
||||
nameof(AdvDriverRead_Faulted),
|
||||
nameof(AdvDriverRead_NoDirect3D12),
|
||||
nameof(AdvDriverRead_NoGetter),
|
||||
nameof(AdvDriverRead_NoModule),
|
||||
nameof(AdvDriverRead_NothingReported),
|
||||
nameof(AdvDriverRead_Read),
|
||||
nameof(AdvDriverRead_Refused),
|
||||
nameof(AdvDriverRead_Slow),
|
||||
nameof(AdvDriverRead_Stalled),
|
||||
nameof(AdvDriverRead_Unknown),
|
||||
nameof(AdvGroup_Board),
|
||||
nameof(AdvGroup_Cpu),
|
||||
nameof(AdvGroup_Display),
|
||||
@@ -322,6 +336,7 @@ public static class Strings
|
||||
nameof(AdvReach_NotInHeaders),
|
||||
nameof(AdvReach_PlayerState),
|
||||
nameof(AdvReach_Refused),
|
||||
nameof(AdvReach_RefusedRoute),
|
||||
nameof(AdvReach_Spike),
|
||||
nameof(AdvScope_MachineFact),
|
||||
nameof(AdvScope_Series),
|
||||
@@ -332,6 +347,7 @@ public static class Strings
|
||||
nameof(AdvSource_PawnIoMissing),
|
||||
nameof(AdvSource_Reading),
|
||||
nameof(AdvSource_Unknown),
|
||||
nameof(AdvToken_active_render),
|
||||
nameof(AdvToken_adaptive_sync),
|
||||
nameof(AdvToken_agp),
|
||||
nameof(AdvToken_axi),
|
||||
@@ -340,10 +356,13 @@ public static class Strings
|
||||
nameof(AdvToken_discrete),
|
||||
nameof(AdvToken_dolby_vision),
|
||||
nameof(AdvToken_draw_debug_view),
|
||||
nameof(AdvToken_driver),
|
||||
nameof(AdvToken_driver_default),
|
||||
nameof(AdvToken_edr),
|
||||
nameof(AdvToken_fpci),
|
||||
nameof(AdvToken_frame_time),
|
||||
nameof(AdvToken_game_ready),
|
||||
nameof(AdvToken_gpu_render),
|
||||
nameof(AdvToken_gsync_module),
|
||||
nameof(AdvToken_hdr10),
|
||||
nameof(AdvToken_hdr10_plus),
|
||||
@@ -360,13 +379,18 @@ public static class Strings
|
||||
nameof(AdvToken_off),
|
||||
nameof(AdvToken_on),
|
||||
nameof(AdvToken_on_and_off),
|
||||
nameof(AdvToken_os_queue),
|
||||
nameof(AdvToken_pci),
|
||||
nameof(AdvToken_pci_express),
|
||||
nameof(AdvToken_present),
|
||||
nameof(AdvToken_render_submit),
|
||||
nameof(AdvToken_rtx_new_feature),
|
||||
nameof(AdvToken_rtx_production),
|
||||
nameof(AdvToken_scrgb_linear),
|
||||
nameof(AdvToken_simulation),
|
||||
nameof(AdvToken_srgb),
|
||||
nameof(AdvToken_studio),
|
||||
nameof(AdvToken_total),
|
||||
nameof(AdvToken_ulmb),
|
||||
nameof(AdvToken_usable_now),
|
||||
nameof(AdvToken_user_set),
|
||||
@@ -1866,6 +1890,8 @@ public static class Strings
|
||||
|
||||
public static string Adv_nvapi_reflex_frame_report => ResourceManager.GetString(nameof(Adv_nvapi_reflex_frame_report), Culture) ?? nameof(Adv_nvapi_reflex_frame_report);
|
||||
|
||||
public static string Adv_nvapi_reflex_gpu_times => ResourceManager.GetString(nameof(Adv_nvapi_reflex_gpu_times), Culture) ?? nameof(Adv_nvapi_reflex_gpu_times);
|
||||
|
||||
public static string Adv_nvapi_reflex_mode => ResourceManager.GetString(nameof(Adv_nvapi_reflex_mode), Culture) ?? nameof(Adv_nvapi_reflex_mode);
|
||||
|
||||
public static string Adv_nvapi_reflex_sleep_status => ResourceManager.GetString(nameof(Adv_nvapi_reflex_sleep_status), Culture) ?? nameof(Adv_nvapi_reflex_sleep_status);
|
||||
@@ -2006,6 +2032,8 @@ public static class Strings
|
||||
|
||||
public static string Advanced_InGameCallsLine => ResourceManager.GetString(nameof(Advanced_InGameCallsLine), Culture) ?? nameof(Advanced_InGameCallsLine);
|
||||
|
||||
public static string Advanced_InGameDriverLine => ResourceManager.GetString(nameof(Advanced_InGameDriverLine), Culture) ?? nameof(Advanced_InGameDriverLine);
|
||||
|
||||
public static string Advanced_InGameFeatureCallsLine => ResourceManager.GetString(nameof(Advanced_InGameFeatureCallsLine), Culture) ?? nameof(Advanced_InGameFeatureCallsLine);
|
||||
|
||||
public static string Advanced_InGameLine => ResourceManager.GetString(nameof(Advanced_InGameLine), Culture) ?? nameof(Advanced_InGameLine);
|
||||
@@ -2052,6 +2080,8 @@ public static class Strings
|
||||
|
||||
public static string Advanced_Status_InGame => ResourceManager.GetString(nameof(Advanced_Status_InGame), Culture) ?? nameof(Advanced_Status_InGame);
|
||||
|
||||
public static string Advanced_Status_InGameDriver => ResourceManager.GetString(nameof(Advanced_Status_InGameDriver), Culture) ?? nameof(Advanced_Status_InGameDriver);
|
||||
|
||||
public static string Advanced_Status_Read => ResourceManager.GetString(nameof(Advanced_Status_Read), Culture) ?? nameof(Advanced_Status_Read);
|
||||
|
||||
public static string Advanced_Status_Readable => ResourceManager.GetString(nameof(Advanced_Status_Readable), Culture) ?? nameof(Advanced_Status_Readable);
|
||||
@@ -2064,6 +2094,28 @@ public static class Strings
|
||||
|
||||
public static string Advanced_Tab_Sources => ResourceManager.GetString(nameof(Advanced_Tab_Sources), Culture) ?? nameof(Advanced_Tab_Sources);
|
||||
|
||||
public static string AdvDriverRead_Error => ResourceManager.GetString(nameof(AdvDriverRead_Error), Culture) ?? nameof(AdvDriverRead_Error);
|
||||
|
||||
public static string AdvDriverRead_Faulted => ResourceManager.GetString(nameof(AdvDriverRead_Faulted), Culture) ?? nameof(AdvDriverRead_Faulted);
|
||||
|
||||
public static string AdvDriverRead_NoDirect3D12 => ResourceManager.GetString(nameof(AdvDriverRead_NoDirect3D12), Culture) ?? nameof(AdvDriverRead_NoDirect3D12);
|
||||
|
||||
public static string AdvDriverRead_NoGetter => ResourceManager.GetString(nameof(AdvDriverRead_NoGetter), Culture) ?? nameof(AdvDriverRead_NoGetter);
|
||||
|
||||
public static string AdvDriverRead_NoModule => ResourceManager.GetString(nameof(AdvDriverRead_NoModule), Culture) ?? nameof(AdvDriverRead_NoModule);
|
||||
|
||||
public static string AdvDriverRead_NothingReported => ResourceManager.GetString(nameof(AdvDriverRead_NothingReported), Culture) ?? nameof(AdvDriverRead_NothingReported);
|
||||
|
||||
public static string AdvDriverRead_Read => ResourceManager.GetString(nameof(AdvDriverRead_Read), Culture) ?? nameof(AdvDriverRead_Read);
|
||||
|
||||
public static string AdvDriverRead_Refused => ResourceManager.GetString(nameof(AdvDriverRead_Refused), Culture) ?? nameof(AdvDriverRead_Refused);
|
||||
|
||||
public static string AdvDriverRead_Slow => ResourceManager.GetString(nameof(AdvDriverRead_Slow), Culture) ?? nameof(AdvDriverRead_Slow);
|
||||
|
||||
public static string AdvDriverRead_Stalled => ResourceManager.GetString(nameof(AdvDriverRead_Stalled), Culture) ?? nameof(AdvDriverRead_Stalled);
|
||||
|
||||
public static string AdvDriverRead_Unknown => ResourceManager.GetString(nameof(AdvDriverRead_Unknown), Culture) ?? nameof(AdvDriverRead_Unknown);
|
||||
|
||||
public static string AdvGroup_Board => ResourceManager.GetString(nameof(AdvGroup_Board), Culture) ?? nameof(AdvGroup_Board);
|
||||
|
||||
public static string AdvGroup_Cpu => ResourceManager.GetString(nameof(AdvGroup_Cpu), Culture) ?? nameof(AdvGroup_Cpu);
|
||||
@@ -2124,6 +2176,8 @@ public static class Strings
|
||||
|
||||
public static string AdvReach_Refused => ResourceManager.GetString(nameof(AdvReach_Refused), Culture) ?? nameof(AdvReach_Refused);
|
||||
|
||||
public static string AdvReach_RefusedRoute => ResourceManager.GetString(nameof(AdvReach_RefusedRoute), Culture) ?? nameof(AdvReach_RefusedRoute);
|
||||
|
||||
public static string AdvReach_Spike => ResourceManager.GetString(nameof(AdvReach_Spike), Culture) ?? nameof(AdvReach_Spike);
|
||||
|
||||
public static string AdvScope_MachineFact => ResourceManager.GetString(nameof(AdvScope_MachineFact), Culture) ?? nameof(AdvScope_MachineFact);
|
||||
@@ -2144,6 +2198,8 @@ public static class Strings
|
||||
|
||||
public static string AdvSource_Unknown => ResourceManager.GetString(nameof(AdvSource_Unknown), Culture) ?? nameof(AdvSource_Unknown);
|
||||
|
||||
public static string AdvToken_active_render => ResourceManager.GetString(nameof(AdvToken_active_render), Culture) ?? nameof(AdvToken_active_render);
|
||||
|
||||
public static string AdvToken_adaptive_sync => ResourceManager.GetString(nameof(AdvToken_adaptive_sync), Culture) ?? nameof(AdvToken_adaptive_sync);
|
||||
|
||||
public static string AdvToken_agp => ResourceManager.GetString(nameof(AdvToken_agp), Culture) ?? nameof(AdvToken_agp);
|
||||
@@ -2160,14 +2216,20 @@ public static class Strings
|
||||
|
||||
public static string AdvToken_draw_debug_view => ResourceManager.GetString(nameof(AdvToken_draw_debug_view), Culture) ?? nameof(AdvToken_draw_debug_view);
|
||||
|
||||
public static string AdvToken_driver => ResourceManager.GetString(nameof(AdvToken_driver), Culture) ?? nameof(AdvToken_driver);
|
||||
|
||||
public static string AdvToken_driver_default => ResourceManager.GetString(nameof(AdvToken_driver_default), Culture) ?? nameof(AdvToken_driver_default);
|
||||
|
||||
public static string AdvToken_edr => ResourceManager.GetString(nameof(AdvToken_edr), Culture) ?? nameof(AdvToken_edr);
|
||||
|
||||
public static string AdvToken_fpci => ResourceManager.GetString(nameof(AdvToken_fpci), Culture) ?? nameof(AdvToken_fpci);
|
||||
|
||||
public static string AdvToken_frame_time => ResourceManager.GetString(nameof(AdvToken_frame_time), Culture) ?? nameof(AdvToken_frame_time);
|
||||
|
||||
public static string AdvToken_game_ready => ResourceManager.GetString(nameof(AdvToken_game_ready), Culture) ?? nameof(AdvToken_game_ready);
|
||||
|
||||
public static string AdvToken_gpu_render => ResourceManager.GetString(nameof(AdvToken_gpu_render), Culture) ?? nameof(AdvToken_gpu_render);
|
||||
|
||||
public static string AdvToken_gsync_module => ResourceManager.GetString(nameof(AdvToken_gsync_module), Culture) ?? nameof(AdvToken_gsync_module);
|
||||
|
||||
public static string AdvToken_hdr10 => ResourceManager.GetString(nameof(AdvToken_hdr10), Culture) ?? nameof(AdvToken_hdr10);
|
||||
@@ -2200,20 +2262,30 @@ public static class Strings
|
||||
|
||||
public static string AdvToken_on_and_off => ResourceManager.GetString(nameof(AdvToken_on_and_off), Culture) ?? nameof(AdvToken_on_and_off);
|
||||
|
||||
public static string AdvToken_os_queue => ResourceManager.GetString(nameof(AdvToken_os_queue), Culture) ?? nameof(AdvToken_os_queue);
|
||||
|
||||
public static string AdvToken_pci => ResourceManager.GetString(nameof(AdvToken_pci), Culture) ?? nameof(AdvToken_pci);
|
||||
|
||||
public static string AdvToken_pci_express => ResourceManager.GetString(nameof(AdvToken_pci_express), Culture) ?? nameof(AdvToken_pci_express);
|
||||
|
||||
public static string AdvToken_present => ResourceManager.GetString(nameof(AdvToken_present), Culture) ?? nameof(AdvToken_present);
|
||||
|
||||
public static string AdvToken_render_submit => ResourceManager.GetString(nameof(AdvToken_render_submit), Culture) ?? nameof(AdvToken_render_submit);
|
||||
|
||||
public static string AdvToken_rtx_new_feature => ResourceManager.GetString(nameof(AdvToken_rtx_new_feature), Culture) ?? nameof(AdvToken_rtx_new_feature);
|
||||
|
||||
public static string AdvToken_rtx_production => ResourceManager.GetString(nameof(AdvToken_rtx_production), Culture) ?? nameof(AdvToken_rtx_production);
|
||||
|
||||
public static string AdvToken_scrgb_linear => ResourceManager.GetString(nameof(AdvToken_scrgb_linear), Culture) ?? nameof(AdvToken_scrgb_linear);
|
||||
|
||||
public static string AdvToken_simulation => ResourceManager.GetString(nameof(AdvToken_simulation), Culture) ?? nameof(AdvToken_simulation);
|
||||
|
||||
public static string AdvToken_srgb => ResourceManager.GetString(nameof(AdvToken_srgb), Culture) ?? nameof(AdvToken_srgb);
|
||||
|
||||
public static string AdvToken_studio => ResourceManager.GetString(nameof(AdvToken_studio), Culture) ?? nameof(AdvToken_studio);
|
||||
|
||||
public static string AdvToken_total => ResourceManager.GetString(nameof(AdvToken_total), Culture) ?? nameof(AdvToken_total);
|
||||
|
||||
public static string AdvToken_ulmb => ResourceManager.GetString(nameof(AdvToken_ulmb), Culture) ?? nameof(AdvToken_ulmb);
|
||||
|
||||
public static string AdvToken_usable_now => ResourceManager.GetString(nameof(AdvToken_usable_now), Culture) ?? nameof(AdvToken_usable_now);
|
||||
|
||||
@@ -385,6 +385,10 @@
|
||||
<value>フレームごとの遅延: シミュレーション、レンダー送信、プレゼント、ドライバー、OS キュー、GPU レンダー</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="Adv_nvapi_reflex_gpu_times" xml:space="preserve">
|
||||
<value>ドライバーが算出するフレームごとの GPU 時間: 実描画時間、フレーム間隔</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="Adv_nvapi_reflex_mode" xml:space="preserve">
|
||||
<value>Reflex: 低遅延モード、ブースト、フレーム レート制限</value>
|
||||
<comment>review</comment>
|
||||
@@ -665,6 +669,10 @@
|
||||
<value>ゲームが毎フレーム Streamline に伝える内容: {0}。FSR フレーム生成の設定方法: {1}。</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="Advanced_InGameDriverLine" xml:space="preserve">
|
||||
<value>NVIDIA の遅延レポート (FrameLedger がゲーム内でグラフィックス ドライバーに問い合わせます): {0}。</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="Advanced_InGameFeatureCallsLine" xml:space="preserve">
|
||||
<value>各 Streamline 機能のバージョン: {0}。各機能の要件: {1}。</value>
|
||||
<comment>review</comment>
|
||||
@@ -757,6 +765,10 @@
|
||||
<value>FrameLedger が計測するゲーム内で、ゲームがその呼び出しを行ったときに読み取り</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="Advanced_Status_InGameDriver" xml:space="preserve">
|
||||
<value>FrameLedger が計測するゲーム内で、グラフィックス ドライバーから読み取り: FrameLedger が約 1 秒に 1 回問い合わせます</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="Advanced_Status_Read" xml:space="preserve">
|
||||
<value>読み取り中</value>
|
||||
<comment>review</comment>
|
||||
@@ -781,6 +793,50 @@
|
||||
<value>ソース</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="AdvDriverRead_Error" xml:space="preserve">
|
||||
<value>ドライバーがエラーを返しました</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="AdvDriverRead_Faulted" xml:space="preserve">
|
||||
<value>ゲーム終了まで停止 - ドライバーへの呼び出しでフォールトが発生しました</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="AdvDriverRead_NoDirect3D12" xml:space="preserve">
|
||||
<value>読み取っていません - このゲームは Direct3D 12 で表示していません</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="AdvDriverRead_NoGetter" xml:space="preserve">
|
||||
<value>読み取っていません - ライブラリが 2 つの関数を返しませんでした</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="AdvDriverRead_NoModule" xml:space="preserve">
|
||||
<value>読み取っていません - ゲームが NVIDIA の nvapi64.dll を読み込んでおらず、FrameLedger がそれを読み込むことはありません</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="AdvDriverRead_NothingReported" xml:space="preserve">
|
||||
<value>問い合わせましたが、ドライバーはフレームを報告しませんでした - このゲームは NVIDIA Reflex を使用していません</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="AdvDriverRead_Read" xml:space="preserve">
|
||||
<value>読み取りました</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="AdvDriverRead_Refused" xml:space="preserve">
|
||||
<value>読み取っていません - ゲーム内の nvapi64.dll はゲーム自身のフォルダーにあり、ドライバーのものではありません</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="AdvDriverRead_Slow" xml:space="preserve">
|
||||
<value>ゲーム終了まで停止 - ドライバーへの呼び出しに {0:N0} µs かかりました。2,000 µs 以上かかった呼び出しが最後になります</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="AdvDriverRead_Stalled" xml:space="preserve">
|
||||
<value>停止 - ドライバーへの呼び出しが戻りませんでした</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="AdvDriverRead_Unknown" xml:space="preserve">
|
||||
<value>記録なし</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="AdvGroup_Board" xml:space="preserve">
|
||||
<value>マザーボード</value>
|
||||
<comment>review</comment>
|
||||
@@ -901,6 +957,10 @@
|
||||
<value>読み取らない: センサー ライブラリがすべての USB デバイスを探索することになるため</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="AdvReach_RefusedRoute" xml:space="preserve">
|
||||
<value>読み取りません: ゲーム実行中にしか分からないアドレスへのパッチ、ベンダーの関数の代わりに FrameLedger の関数をゲームに渡すこと、またはゲーム自身のスレッド以外からの呼び出しをベンダーが禁じている関数が必要になるためです - いずれも行いません</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="AdvReach_Spike" xml:space="preserve">
|
||||
<value>調査中 (未決定)</value>
|
||||
<comment>review</comment>
|
||||
@@ -969,6 +1029,10 @@
|
||||
<value>Dolby Vision</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="AdvToken_driver" xml:space="preserve">
|
||||
<value>ドライバー</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="AdvToken_driver_default" xml:space="preserve">
|
||||
<value>ドライバーの既定値</value>
|
||||
<comment>review</comment>
|
||||
@@ -989,6 +1053,18 @@
|
||||
<value>Game Ready</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="AdvToken_active_render" xml:space="preserve">
|
||||
<value>GPU 実描画 (ドライバーの算出値)</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="AdvToken_frame_time" xml:space="preserve">
|
||||
<value>GPU フレーム時間 (前のフレームの終了から次の終了まで)</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="AdvToken_gpu_render" xml:space="preserve">
|
||||
<value>GPU 描画 (ドライバーの開始マークから終了マークまで)</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="AdvToken_gsync_module" xml:space="preserve">
|
||||
<value>G-SYNC モジュール</value>
|
||||
<comment>review</comment>
|
||||
@@ -1053,6 +1129,10 @@
|
||||
<value>オンのときとオフのときがあります</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="AdvToken_os_queue" xml:space="preserve">
|
||||
<value>OS の描画キュー</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="AdvToken_pci" xml:space="preserve">
|
||||
<value>PCI</value>
|
||||
<comment>review</comment>
|
||||
@@ -1061,6 +1141,14 @@
|
||||
<value>PCI Express</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="AdvToken_present" xml:space="preserve">
|
||||
<value>プレゼント</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="AdvToken_render_submit" xml:space="preserve">
|
||||
<value>描画コマンドの送信</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="AdvToken_rtx_new_feature" xml:space="preserve">
|
||||
<value>RTX 新機能ブランチ</value>
|
||||
<comment>review</comment>
|
||||
@@ -1073,6 +1161,10 @@
|
||||
<value>scRGB (リニア)</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="AdvToken_simulation" xml:space="preserve">
|
||||
<value>シミュレーション</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="AdvToken_srgb" xml:space="preserve">
|
||||
<value>sRGB</value>
|
||||
<comment>review</comment>
|
||||
@@ -1081,6 +1173,10 @@
|
||||
<value>Studio</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="AdvToken_total" xml:space="preserve">
|
||||
<value>合計 (シミュレーション開始から GPU 描画終了まで)</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="AdvToken_ulmb" xml:space="preserve">
|
||||
<value>ULMB</value>
|
||||
<comment>review</comment>
|
||||
@@ -1486,7 +1582,7 @@
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="Settings_Advanced_Body" xml:space="preserve">
|
||||
<value>セッション中にグラフィックス ドライバーとハードウェア センサーからさらに多くを読み取り、セッションと一緒に保存します - グラフィックス カードのメモリと負荷の詳細、各ファンと電圧、ディスプレイの対応機能、ゲームに対するドライバーの設定など。FrameLedger が内部から計測するゲームでは、ゲームが DLSS、Streamline、FSR に渡す内容 (サイズ、プリセット、シャープニング、露出、深度範囲、フレーム生成の設定) も読み取ります - カメラの位置は決して読み取りません。オフ: ゲーム内も含め、追加の読み取りも保存も行いません。次のセッションから適用され、オフの間に記録したセッションが後から補われることはありません。</value>
|
||||
<value>セッション中にグラフィックス ドライバーとハードウェア センサーからさらに多くを読み取り、セッションと一緒に保存します - グラフィックス カードのメモリと負荷の詳細、各ファンと電圧、ディスプレイの対応機能、ゲームに対するドライバーの設定など。FrameLedger が内部から計測するゲームでは、ゲームが DLSS、Streamline、FSR に渡す内容 (サイズ、プリセット、シャープニング、露出、深度範囲、フレーム生成の設定) も読み取ります - カメラの位置は決して読み取りません。NVIDIA のカードで、NVIDIA のライブラリを使用する Direct3D 12 のゲームでは、フレームの各段階にかかった時間を、FrameLedger がゲーム内から約 1 秒に 1 回グラフィックス ドライバーに問い合わせます - これは、ゲームのフレームを表示するスレッド上で FrameLedger 自身が行う呼び出しです。オフ: ゲーム内も含め、追加の読み取りも保存も行いません。次のセッションから適用され、オフの間に記録したセッションが後から補われることはありません。</value>
|
||||
<comment>review</comment>
|
||||
</data>
|
||||
<data name="Settings_Advanced_Label" xml:space="preserve">
|
||||
|
||||
@@ -294,6 +294,9 @@
|
||||
<data name="Adv_nvapi_reflex_frame_report" xml:space="preserve">
|
||||
<value>Latency per frame: simulation, render submit, present, driver, OS queue, GPU render</value>
|
||||
</data>
|
||||
<data name="Adv_nvapi_reflex_gpu_times" xml:space="preserve">
|
||||
<value>The graphics card's time per frame, as the driver works it out: active render, frame to frame</value>
|
||||
</data>
|
||||
<data name="Adv_nvapi_reflex_mode" xml:space="preserve">
|
||||
<value>Reflex: low-latency mode, boost, the frame-rate limit</value>
|
||||
</data>
|
||||
@@ -504,6 +507,9 @@
|
||||
<data name="Advanced_InGameCallsLine" xml:space="preserve">
|
||||
<value>What the game tells Streamline each frame: {0}. How it configures FSR frame generation: {1}.</value>
|
||||
</data>
|
||||
<data name="Advanced_InGameDriverLine" xml:space="preserve">
|
||||
<value>NVIDIA's latency report, which FrameLedger asks the graphics driver for inside the game: {0}.</value>
|
||||
</data>
|
||||
<data name="Advanced_InGameFeatureCallsLine" xml:space="preserve">
|
||||
<value>Which version each Streamline feature is: {0}. What each requires: {1}.</value>
|
||||
</data>
|
||||
@@ -573,6 +579,9 @@
|
||||
<data name="Advanced_Status_InGame" xml:space="preserve">
|
||||
<value>Read inside a game FrameLedger measures, when the game makes the call</value>
|
||||
</data>
|
||||
<data name="Advanced_Status_InGameDriver" xml:space="preserve">
|
||||
<value>Read inside a game FrameLedger measures, from the graphics driver: FrameLedger asks for it about once a second</value>
|
||||
</data>
|
||||
<data name="Advanced_Status_Read" xml:space="preserve">
|
||||
<value>Read</value>
|
||||
</data>
|
||||
@@ -591,6 +600,39 @@
|
||||
<data name="Advanced_Tab_Sources" xml:space="preserve">
|
||||
<value>Sources</value>
|
||||
</data>
|
||||
<data name="AdvDriverRead_Error" xml:space="preserve">
|
||||
<value>the driver answered with an error</value>
|
||||
</data>
|
||||
<data name="AdvDriverRead_Faulted" xml:space="preserve">
|
||||
<value>stopped until the game closed - a call into the driver faulted</value>
|
||||
</data>
|
||||
<data name="AdvDriverRead_NoDirect3D12" xml:space="preserve">
|
||||
<value>not read - the game does not present through Direct3D 12</value>
|
||||
</data>
|
||||
<data name="AdvDriverRead_NoGetter" xml:space="preserve">
|
||||
<value>not read - the library did not answer for the two functions</value>
|
||||
</data>
|
||||
<data name="AdvDriverRead_NoModule" xml:space="preserve">
|
||||
<value>not read - the game has not loaded NVIDIA's nvapi64.dll, and FrameLedger never loads it</value>
|
||||
</data>
|
||||
<data name="AdvDriverRead_NothingReported" xml:space="preserve">
|
||||
<value>asked, and the driver reported no frame - the game does not use NVIDIA Reflex</value>
|
||||
</data>
|
||||
<data name="AdvDriverRead_Read" xml:space="preserve">
|
||||
<value>read</value>
|
||||
</data>
|
||||
<data name="AdvDriverRead_Refused" xml:space="preserve">
|
||||
<value>not read - the nvapi64.dll in the game is in the game's own folder, not the driver's</value>
|
||||
</data>
|
||||
<data name="AdvDriverRead_Slow" xml:space="preserve">
|
||||
<value>stopped until the game closed - a call into the driver took {0:N0} µs, and one of 2,000 µs or more is the last</value>
|
||||
</data>
|
||||
<data name="AdvDriverRead_Stalled" xml:space="preserve">
|
||||
<value>stopped - a call into the driver did not return</value>
|
||||
</data>
|
||||
<data name="AdvDriverRead_Unknown" xml:space="preserve">
|
||||
<value>not stated</value>
|
||||
</data>
|
||||
<data name="AdvGroup_Board" xml:space="preserve">
|
||||
<value>Motherboard</value>
|
||||
</data>
|
||||
@@ -681,6 +723,9 @@
|
||||
<data name="AdvReach_Refused" xml:space="preserve">
|
||||
<value>Not read: it would make the sensor library search every USB device</value>
|
||||
</data>
|
||||
<data name="AdvReach_RefusedRoute" xml:space="preserve">
|
||||
<value>Not read: it would take a patch at an address found while the game runs, a function of FrameLedger's handed to the game in place of the vendor's, or a call the vendor forbids from outside the game's own threads - all refused</value>
|
||||
</data>
|
||||
<data name="AdvReach_Spike" xml:space="preserve">
|
||||
<value>Being studied; not decided</value>
|
||||
</data>
|
||||
@@ -732,6 +777,9 @@
|
||||
<data name="AdvToken_dolby_vision" xml:space="preserve">
|
||||
<value>Dolby Vision</value>
|
||||
</data>
|
||||
<data name="AdvToken_driver" xml:space="preserve">
|
||||
<value>driver</value>
|
||||
</data>
|
||||
<data name="AdvToken_driver_default" xml:space="preserve">
|
||||
<value>Driver default</value>
|
||||
</data>
|
||||
@@ -747,6 +795,15 @@
|
||||
<data name="AdvToken_game_ready" xml:space="preserve">
|
||||
<value>Game Ready</value>
|
||||
</data>
|
||||
<data name="AdvToken_active_render" xml:space="preserve">
|
||||
<value>GPU active render (the driver's own figure)</value>
|
||||
</data>
|
||||
<data name="AdvToken_frame_time" xml:space="preserve">
|
||||
<value>GPU frame time, one frame's end to the next</value>
|
||||
</data>
|
||||
<data name="AdvToken_gpu_render" xml:space="preserve">
|
||||
<value>GPU render (between the driver's start and end marks)</value>
|
||||
</data>
|
||||
<data name="AdvToken_gsync_module" xml:space="preserve">
|
||||
<value>G-SYNC module</value>
|
||||
</data>
|
||||
@@ -795,12 +852,21 @@
|
||||
<data name="AdvToken_on_and_off" xml:space="preserve">
|
||||
<value>On at times, off at others</value>
|
||||
</data>
|
||||
<data name="AdvToken_os_queue" xml:space="preserve">
|
||||
<value>operating system's render queue</value>
|
||||
</data>
|
||||
<data name="AdvToken_pci" xml:space="preserve">
|
||||
<value>PCI</value>
|
||||
</data>
|
||||
<data name="AdvToken_pci_express" xml:space="preserve">
|
||||
<value>PCI Express</value>
|
||||
</data>
|
||||
<data name="AdvToken_present" xml:space="preserve">
|
||||
<value>present</value>
|
||||
</data>
|
||||
<data name="AdvToken_render_submit" xml:space="preserve">
|
||||
<value>render submit</value>
|
||||
</data>
|
||||
<data name="AdvToken_rtx_new_feature" xml:space="preserve">
|
||||
<value>RTX new-feature branch</value>
|
||||
</data>
|
||||
@@ -810,12 +876,18 @@
|
||||
<data name="AdvToken_scrgb_linear" xml:space="preserve">
|
||||
<value>scRGB (linear)</value>
|
||||
</data>
|
||||
<data name="AdvToken_simulation" xml:space="preserve">
|
||||
<value>simulation</value>
|
||||
</data>
|
||||
<data name="AdvToken_srgb" xml:space="preserve">
|
||||
<value>sRGB</value>
|
||||
</data>
|
||||
<data name="AdvToken_studio" xml:space="preserve">
|
||||
<value>Studio</value>
|
||||
</data>
|
||||
<data name="AdvToken_total" xml:space="preserve">
|
||||
<value>total, simulation start to GPU render end</value>
|
||||
</data>
|
||||
<data name="AdvToken_ulmb" xml:space="preserve">
|
||||
<value>ULMB</value>
|
||||
</data>
|
||||
@@ -1120,7 +1192,7 @@
|
||||
<value>The agent did not answer the rules update.</value>
|
||||
</data>
|
||||
<data name="Settings_Advanced_Body" xml:space="preserve">
|
||||
<value>Read more from the graphics driver and the hardware sensors during a session - the graphics card's memory and load in detail, each fan and voltage, what your display can do, the driver's settings for the game - and, in a game FrameLedger measures from inside, what the game tells DLSS, Streamline and FSR (sizes, presets, sharpening, exposure, the depth range, how frame generation is configured - never where the camera is). All of it is stored with the session. Off: nothing more is read or stored, inside a game either. It applies from the next session, and a session recorded while it was off is not filled in later.</value>
|
||||
<value>Read more from the graphics driver and the hardware sensors during a session - the graphics card's memory and load in detail, each fan and voltage, what your display can do, the driver's settings for the game - and, in a game FrameLedger measures from inside, what the game tells DLSS, Streamline and FSR (sizes, presets, sharpening, exposure, the depth range, how frame generation is configured - never where the camera is). On an NVIDIA card, in a Direct3D 12 game that uses NVIDIA's own library, FrameLedger also asks the graphics driver about once a second, from inside the game, how long each stage of a frame took - a call it makes itself on the thread that shows the game's frames. All of it is stored with the session. Off: nothing more is read or stored, inside a game either. It applies from the next session, and a session recorded while it was off is not filled in later.</value>
|
||||
</data>
|
||||
<data name="Settings_Advanced_Label" xml:space="preserve">
|
||||
<value>Advanced metrics</value>
|
||||
|
||||
@@ -289,6 +289,9 @@
|
||||
<data name="Adv_nvapi_reflex_frame_report" xml:space="preserve">
|
||||
<value>Độ trễ từng khung hình: mô phỏng, gửi lệnh dựng hình, present, driver, hàng đợi hệ điều hành, GPU dựng hình</value>
|
||||
</data>
|
||||
<data name="Adv_nvapi_reflex_gpu_times" xml:space="preserve">
|
||||
<value>Thời gian của card đồ hoạ cho mỗi khung hình, do driver tự tính: lúc thực sự vẽ, và từ khung này sang khung kế</value>
|
||||
</data>
|
||||
<data name="Adv_nvapi_reflex_mode" xml:space="preserve">
|
||||
<value>Reflex: chế độ độ trễ thấp, boost, giới hạn tốc độ khung hình</value>
|
||||
</data>
|
||||
@@ -499,6 +502,9 @@
|
||||
<data name="Advanced_InGameCallsLine" xml:space="preserve">
|
||||
<value>Những gì game báo cho Streamline mỗi khung hình: {0}. Cách game cấu hình frame generation của FSR: {1}.</value>
|
||||
</data>
|
||||
<data name="Advanced_InGameDriverLine" xml:space="preserve">
|
||||
<value>Báo cáo độ trễ của NVIDIA, do FrameLedger hỏi driver đồ họa ngay bên trong game: {0}.</value>
|
||||
</data>
|
||||
<data name="Advanced_InGameFeatureCallsLine" xml:space="preserve">
|
||||
<value>Mỗi tính năng Streamline là phiên bản nào: {0}. Mỗi tính năng cần gì: {1}.</value>
|
||||
</data>
|
||||
@@ -568,6 +574,9 @@
|
||||
<data name="Advanced_Status_InGame" xml:space="preserve">
|
||||
<value>Được đọc bên trong game mà FrameLedger đo, khi game thực hiện lời gọi đó</value>
|
||||
</data>
|
||||
<data name="Advanced_Status_InGameDriver" xml:space="preserve">
|
||||
<value>Được đọc bên trong game mà FrameLedger đo, từ driver đồ họa: FrameLedger hỏi khoảng mỗi giây một lần</value>
|
||||
</data>
|
||||
<data name="Advanced_Status_Read" xml:space="preserve">
|
||||
<value>Đang đọc</value>
|
||||
</data>
|
||||
@@ -586,6 +595,39 @@
|
||||
<data name="Advanced_Tab_Sources" xml:space="preserve">
|
||||
<value>Nguồn</value>
|
||||
</data>
|
||||
<data name="AdvDriverRead_Error" xml:space="preserve">
|
||||
<value>driver trả về lỗi</value>
|
||||
</data>
|
||||
<data name="AdvDriverRead_Faulted" xml:space="preserve">
|
||||
<value>đã dừng cho tới khi đóng game - một lời gọi vào driver gặp lỗi (fault)</value>
|
||||
</data>
|
||||
<data name="AdvDriverRead_NoDirect3D12" xml:space="preserve">
|
||||
<value>không đọc - game không hiển thị qua Direct3D 12</value>
|
||||
</data>
|
||||
<data name="AdvDriverRead_NoGetter" xml:space="preserve">
|
||||
<value>không đọc - thư viện không trả về hai hàm cần gọi</value>
|
||||
</data>
|
||||
<data name="AdvDriverRead_NoModule" xml:space="preserve">
|
||||
<value>không đọc - game chưa nạp nvapi64.dll của NVIDIA, và FrameLedger không bao giờ nạp nó</value>
|
||||
</data>
|
||||
<data name="AdvDriverRead_NothingReported" xml:space="preserve">
|
||||
<value>đã hỏi, driver không báo khung hình nào - game không dùng NVIDIA Reflex</value>
|
||||
</data>
|
||||
<data name="AdvDriverRead_Read" xml:space="preserve">
|
||||
<value>đã đọc</value>
|
||||
</data>
|
||||
<data name="AdvDriverRead_Refused" xml:space="preserve">
|
||||
<value>không đọc - nvapi64.dll trong game nằm ở chính thư mục của game, không phải của driver</value>
|
||||
</data>
|
||||
<data name="AdvDriverRead_Slow" xml:space="preserve">
|
||||
<value>đã dừng cho tới khi đóng game - một lời gọi vào driver mất {0:N0} µs, và lời gọi từ 2.000 µs trở lên là lời gọi cuối</value>
|
||||
</data>
|
||||
<data name="AdvDriverRead_Stalled" xml:space="preserve">
|
||||
<value>đã dừng - một lời gọi vào driver không trả về</value>
|
||||
</data>
|
||||
<data name="AdvDriverRead_Unknown" xml:space="preserve">
|
||||
<value>không được ghi</value>
|
||||
</data>
|
||||
<data name="AdvGroup_Board" xml:space="preserve">
|
||||
<value>Bo mạch chủ</value>
|
||||
</data>
|
||||
@@ -676,6 +718,9 @@
|
||||
<data name="AdvReach_Refused" xml:space="preserve">
|
||||
<value>Không đọc: việc này khiến thư viện cảm biến dò mọi thiết bị USB</value>
|
||||
</data>
|
||||
<data name="AdvReach_RefusedRoute" xml:space="preserve">
|
||||
<value>Không đọc: việc đó cần vá mã tại một địa chỉ chỉ tìm được khi game đang chạy, hoặc đưa cho game một hàm của FrameLedger thay cho hàm của nhà cung cấp, hoặc một lời gọi mà nhà cung cấp cấm thực hiện từ ngoài luồng của game - tất cả đều bị từ chối</value>
|
||||
</data>
|
||||
<data name="AdvReach_Spike" xml:space="preserve">
|
||||
<value>Đang nghiên cứu; chưa quyết định</value>
|
||||
</data>
|
||||
@@ -727,6 +772,9 @@
|
||||
<data name="AdvToken_dolby_vision" xml:space="preserve">
|
||||
<value>Dolby Vision</value>
|
||||
</data>
|
||||
<data name="AdvToken_driver" xml:space="preserve">
|
||||
<value>driver</value>
|
||||
</data>
|
||||
<data name="AdvToken_driver_default" xml:space="preserve">
|
||||
<value>Mặc định của driver</value>
|
||||
</data>
|
||||
@@ -742,6 +790,15 @@
|
||||
<data name="AdvToken_game_ready" xml:space="preserve">
|
||||
<value>Game Ready</value>
|
||||
</data>
|
||||
<data name="AdvToken_active_render" xml:space="preserve">
|
||||
<value>GPU thực sự vẽ (số do driver tự tính)</value>
|
||||
</data>
|
||||
<data name="AdvToken_frame_time" xml:space="preserve">
|
||||
<value>nhịp khung của GPU, từ lúc xong khung này tới lúc xong khung kế</value>
|
||||
</data>
|
||||
<data name="AdvToken_gpu_render" xml:space="preserve">
|
||||
<value>GPU vẽ (giữa mốc bắt đầu và mốc kết thúc của driver)</value>
|
||||
</data>
|
||||
<data name="AdvToken_gsync_module" xml:space="preserve">
|
||||
<value>Mô-đun G-SYNC</value>
|
||||
</data>
|
||||
@@ -790,12 +847,21 @@
|
||||
<data name="AdvToken_on_and_off" xml:space="preserve">
|
||||
<value>Lúc bật, lúc tắt</value>
|
||||
</data>
|
||||
<data name="AdvToken_os_queue" xml:space="preserve">
|
||||
<value>hàng đợi vẽ của hệ điều hành</value>
|
||||
</data>
|
||||
<data name="AdvToken_pci" xml:space="preserve">
|
||||
<value>PCI</value>
|
||||
</data>
|
||||
<data name="AdvToken_pci_express" xml:space="preserve">
|
||||
<value>PCI Express</value>
|
||||
</data>
|
||||
<data name="AdvToken_present" xml:space="preserve">
|
||||
<value>present</value>
|
||||
</data>
|
||||
<data name="AdvToken_render_submit" xml:space="preserve">
|
||||
<value>gửi lệnh vẽ</value>
|
||||
</data>
|
||||
<data name="AdvToken_rtx_new_feature" xml:space="preserve">
|
||||
<value>Nhánh RTX tính năng mới</value>
|
||||
</data>
|
||||
@@ -805,12 +871,18 @@
|
||||
<data name="AdvToken_scrgb_linear" xml:space="preserve">
|
||||
<value>scRGB (tuyến tính)</value>
|
||||
</data>
|
||||
<data name="AdvToken_simulation" xml:space="preserve">
|
||||
<value>mô phỏng</value>
|
||||
</data>
|
||||
<data name="AdvToken_srgb" xml:space="preserve">
|
||||
<value>sRGB</value>
|
||||
</data>
|
||||
<data name="AdvToken_studio" xml:space="preserve">
|
||||
<value>Studio</value>
|
||||
</data>
|
||||
<data name="AdvToken_total" xml:space="preserve">
|
||||
<value>tổng, từ đầu mô phỏng tới khi GPU vẽ xong</value>
|
||||
</data>
|
||||
<data name="AdvToken_ulmb" xml:space="preserve">
|
||||
<value>ULMB</value>
|
||||
</data>
|
||||
@@ -1115,7 +1187,7 @@
|
||||
<value>Agent không phản hồi yêu cầu cập nhật quy tắc.</value>
|
||||
</data>
|
||||
<data name="Settings_Advanced_Body" xml:space="preserve">
|
||||
<value>Đọc thêm từ driver đồ hoạ và các cảm biến phần cứng trong lúc ghi phiên - bộ nhớ và tải của card đồ hoạ ở mức chi tiết, từng quạt và điện áp, khả năng của màn hình, thiết lập của driver cho game - và, với game mà FrameLedger đo từ bên trong, những gì game đưa cho DLSS, Streamline và FSR (kích thước, preset, làm nét, phơi sáng, khoảng độ sâu, cách cấu hình frame generation - không bao giờ là vị trí camera). Tất cả được lưu cùng phiên. Tắt: không đọc và không lưu thêm gì, kể cả bên trong game. Áp dụng từ phiên kế tiếp; phiên đã ghi lúc tắt sẽ không được bổ sung về sau.</value>
|
||||
<value>Đọc thêm từ driver đồ hoạ và các cảm biến phần cứng trong lúc ghi phiên - bộ nhớ và tải của card đồ hoạ ở mức chi tiết, từng quạt và điện áp, khả năng của màn hình, thiết lập của driver cho game - và, với game mà FrameLedger đo từ bên trong, những gì game đưa cho DLSS, Streamline và FSR (kích thước, preset, làm nét, phơi sáng, khoảng độ sâu, cách cấu hình frame generation - không bao giờ là vị trí camera). Với card NVIDIA, trong game Direct3D 12 có dùng thư viện của NVIDIA, FrameLedger còn hỏi driver đồ hoạ khoảng mỗi giây một lần, ngay bên trong game, xem từng chặng của một khung hình mất bao lâu - đây là lời gọi do chính FrameLedger thực hiện trên luồng hiển thị khung hình của game. Tất cả được lưu cùng phiên. Tắt: không đọc và không lưu thêm gì, kể cả bên trong game. Áp dụng từ phiên kế tiếp; phiên đã ghi lúc tắt sẽ không được bổ sung về sau.</value>
|
||||
</data>
|
||||
<data name="Settings_Advanced_Label" xml:space="preserve">
|
||||
<value>Thông số nâng cao</value>
|
||||
|
||||
@@ -63,6 +63,16 @@ public static class AdvancedLabels
|
||||
/// <summary>A token the driver's answer was mapped to; the token itself where this build has no word for it.</summary>
|
||||
public static string Token(string token) => Lookup("AdvToken_" + token) ?? token;
|
||||
|
||||
/// <summary>
|
||||
/// What became of the driver's latency report in a session, in words. A read stopped for being slow says how
|
||||
/// slow: <paramref name="slowestUs"/> is the session's slowest call into the driver, in microseconds.
|
||||
/// </summary>
|
||||
public static string DriverRead(AdvancedDriverRead read, int? slowestUs)
|
||||
{
|
||||
string text = Lookup("AdvDriverRead_" + read) ?? read.ToString();
|
||||
return read == AdvancedDriverRead.Slow ? string.Format(CultureInfo.CurrentCulture, text, slowestUs ?? 0) : text;
|
||||
}
|
||||
|
||||
/// <summary>A number in its unit. A flag is yes or no; a count has no unit.</summary>
|
||||
public static string Number(double value, AdvancedUnit unit)
|
||||
{
|
||||
|
||||
@@ -90,7 +90,9 @@ public static class AdvancedPresenter
|
||||
}
|
||||
}
|
||||
|
||||
return owner is null ? (null, series) : (owner, AdvancedLabels.Member(AdvancedLabels.Of(owner), id[(owner.Id.Length + 1)..]));
|
||||
// The member's own name, translated where it is one of ours (the spans of the driver's latency report) and
|
||||
// shown as it is where it is the hardware's.
|
||||
return owner is null ? (null, series) : (owner, AdvancedLabels.Member(AdvancedLabels.Of(owner), AdvancedLabels.Token(id[(owner.Id.Length + 1)..])));
|
||||
}
|
||||
|
||||
/// <summary>Every series as it reads now, in the catalog's order: its value in its unit and the time it was read at.</summary>
|
||||
@@ -223,6 +225,17 @@ public static class AdvancedPresenter
|
||||
line += " " + more;
|
||||
}
|
||||
|
||||
// The driver's latency report (train C): not one of the game's calls, so a sentence of its own - what became
|
||||
// of the read FrameLedger makes itself, with the microseconds when it was stopped for being slow. A row
|
||||
// stored before, and a session that says nothing about it, do not carry it.
|
||||
if (sources.DriverLatency is { } driver && driver != AdvancedDriverRead.Unknown)
|
||||
{
|
||||
line += " " + string.Format(
|
||||
CultureInfo.CurrentCulture,
|
||||
Strings.Advanced_InGameDriverLine,
|
||||
AdvancedLabels.DriverRead(driver, sources.DriverLatencySlowestUs));
|
||||
}
|
||||
|
||||
return line;
|
||||
}
|
||||
|
||||
@@ -269,6 +282,12 @@ public static class AdvancedPresenter
|
||||
return Strings.Advanced_Status_InGame;
|
||||
}
|
||||
|
||||
if (metric.Reach == AdvancedReach.GameDriver)
|
||||
{
|
||||
// Nor this: read inside a game being measured, by a call FrameLedger makes into the driver itself.
|
||||
return Strings.Advanced_Status_InGameDriver;
|
||||
}
|
||||
|
||||
AdvancedSourceStatus? state = now is null ? null : (metric.Source, metric.Reach) switch
|
||||
{
|
||||
(AdvancedSource.Nvapi, _) => now.Nvapi,
|
||||
|
||||
@@ -0,0 +1,47 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
namespace FrameLedger.Application.Advanced;
|
||||
|
||||
/// <summary>
|
||||
/// What became, in one session, of the one thing FrameLedger reads inside a game that is not an argument of a call
|
||||
/// it hooks: the graphics driver's latency report, which the part inside the game asks NVIDIA's driver for itself,
|
||||
/// about once a second (Advanced metrics train C; owner decisions D132, D136, D138-D141; the entries of reach
|
||||
/// <see cref="AdvancedReach.GameDriver"/>). Beside <see cref="AdvancedInGameCall"/> because the reasons a value is
|
||||
/// absent are different ones: there is no hook to be in or out, and there is a driver that can refuse.
|
||||
/// </summary>
|
||||
public enum AdvancedDriverRead
|
||||
{
|
||||
/// <summary>Not stated: a row stored before this existed, or a session the part inside the game said nothing about.</summary>
|
||||
Unknown = 0,
|
||||
|
||||
/// <summary>The driver was asked and reported frames.</summary>
|
||||
Read = 1,
|
||||
|
||||
/// <summary>The driver was asked and reported no frame: the game does not use NVIDIA Reflex.</summary>
|
||||
NothingReported = 2,
|
||||
|
||||
/// <summary>The game does not present through Direct3D 12, the one interface this is read on.</summary>
|
||||
NoDirect3D12 = 3,
|
||||
|
||||
/// <summary>The game has not loaded NVIDIA's <c>nvapi64.dll</c>, and FrameLedger never loads it.</summary>
|
||||
NoModule = 4,
|
||||
|
||||
/// <summary>The <c>nvapi64.dll</c> in the game sits in the game's own folder: a replacement, not the driver's (D140).</summary>
|
||||
Refused = 5,
|
||||
|
||||
/// <summary>The module did not answer for the two functions.</summary>
|
||||
NoGetter = 6,
|
||||
|
||||
/// <summary>The driver answered every read with an error.</summary>
|
||||
Error = 7,
|
||||
|
||||
/// <summary>One call took two milliseconds or more: the read was switched off until the game exited (D141).</summary>
|
||||
Slow = 8,
|
||||
|
||||
/// <summary>A call into the driver faulted: the read was switched off until the game exited.</summary>
|
||||
Faulted = 9,
|
||||
|
||||
/// <summary>A call into the driver did not return.</summary>
|
||||
Stalled = 10,
|
||||
}
|
||||
@@ -37,7 +37,7 @@ public sealed record AdvancedMetric(
|
||||
public bool IsFamily { get; init; }
|
||||
|
||||
/// <summary>True when a build with the option on reads it: every other reach is a reason it reads N/A.</summary>
|
||||
public bool IsRead => Reach is AdvancedReach.Agent or AdvancedReach.AgentElevated or AdvancedReach.Game;
|
||||
public bool IsRead => Reach is AdvancedReach.Agent or AdvancedReach.AgentElevated or AdvancedReach.Game or AdvancedReach.GameDriver;
|
||||
|
||||
/// <summary>The name of its series in <c>sensor_blobs</c> — for a family, the stem of its instances' names; null when it is not a series.</summary>
|
||||
public string? SeriesName => Scope == AdvancedScope.Series ? SeriesPrefix + Id : null;
|
||||
|
||||
@@ -182,21 +182,35 @@ public static class AdvancedMetricCatalog
|
||||
Session("sl.init.preferences", Streamline, BeforeAttach, Text, Upscaling, "The preferences the game started Streamline with"),
|
||||
Session("sl.constants.camera", Streamline, PlayerState, Text, Upscaling, "Camera position, axes and matrices"),
|
||||
|
||||
// ---- Inside the game: routes a spike decides ------------------------------------------------------------
|
||||
Session("nvapi.reflex.mode", Nvapi, Spike, Text, Latency, "Reflex: low-latency mode, boost, the frame-rate limit"),
|
||||
Session("nvapi.reflex.sleep_status", Nvapi, Spike, Text, Latency, "What the driver's low-latency state is"),
|
||||
SampledFamily("nvapi.reflex.frame_report", Nvapi, Spike, Microseconds, Latency, "Latency per frame: simulation, render submit, present, driver, OS queue, GPU render"),
|
||||
Session("sl.dlss.optimal_settings", Streamline, Spike, Text, Upscaling, "The render size and sharpness DLSS recommends"),
|
||||
Sampled("sl.dlss.vram_estimate", Streamline, Spike, Mebibytes, Upscaling, "DLSS's own estimate of its video memory"),
|
||||
Session("sl.dlssg.options", Streamline, Spike, Text, FrameGeneration, "DLSS frame generation: mode, frames to generate"),
|
||||
Session("sl.dlssg.state", Streamline, Spike, Text, FrameGeneration, "DLSS frame generation: status, the most frames it can generate"),
|
||||
Sampled("sl.dlssg.frames_presented", Streamline, Spike, Count, FrameGeneration, "Frames DLSS frame generation presented, by its own count"),
|
||||
Sampled("sl.dlssg.vram_estimate", Streamline, Spike, Mebibytes, FrameGeneration, "DLSS frame generation's estimate of its video memory"),
|
||||
Session("sl.dlssd.options", Streamline, Spike, Text, Upscaling, "Ray reconstruction's options"),
|
||||
Session("sl.nis.options", Streamline, Spike, Text, Upscaling, "NVIDIA Image Scaling's options"),
|
||||
Session("sl.deepdvc.options", Streamline, Spike, Text, Upscaling, "RTX Dynamic Vibrance's options"),
|
||||
Session("sl.reflex.state", Streamline, Spike, Table, Latency, "Reflex through Streamline: availability and its frame reports"),
|
||||
Sampled("sl.pcl.markers", Streamline, Spike, Count, Latency, "PC-latency markers the game sets"),
|
||||
// ---- Inside the game: what the driver reports, asked for by the part inside the game itself (train C) ------
|
||||
// Not an argument of a hooked call: two read-only getters of the driver, about once a second (D132, D136).
|
||||
// What the GAME asked of Reflex - the mode, boost, the limit - is an argument of a function that is not an
|
||||
// export: reading it needs a patch at an address learned at run time, the class refused on 2026-08-09.
|
||||
Session("nvapi.reflex.mode", Nvapi, RefusedRoute, Text, Latency, "Reflex: low-latency mode, boost, the frame-rate limit"),
|
||||
Session("nvapi.reflex.sleep_status", Nvapi, GameDriver, Table, Latency, "What the driver's low-latency state is"),
|
||||
SampledFamily("nvapi.reflex.frame_report", Nvapi, GameDriver, Microseconds, Latency, "Latency per frame: simulation, render submit, present, driver, OS queue, GPU render"),
|
||||
// Two figures the driver works out itself, members of the same report (0.1.0-beta.48, D142): the span between
|
||||
// its two GPU marks includes the card's idle time and was longer than a frame's whole in a real game.
|
||||
SampledFamily("nvapi.reflex.gpu_times", Nvapi, GameDriver, Microseconds, Latency, "The graphics card's time per frame, as the driver works it out: active render, frame to frame"),
|
||||
|
||||
// ---- Inside the game: Streamline's feature functions - not read ---------------------------------------
|
||||
// Advanced metrics is closed (owner decision D154, 2026-11-14). None of these is an export: a game gets each
|
||||
// function through slGetFeatureFunction and keeps the pointer, so seeing its calls would take handing the game
|
||||
// a function of ours in place of Streamline's - a write to what the game receives (rule 4) - and would still
|
||||
// miss every game that fetched its functions before the attach. They stay listed, with the reason.
|
||||
Session("sl.dlss.optimal_settings", Streamline, RefusedRoute, Text, Upscaling, "The render size and sharpness DLSS recommends"),
|
||||
Sampled("sl.dlss.vram_estimate", Streamline, RefusedRoute, Mebibytes, Upscaling, "DLSS's own estimate of its video memory"),
|
||||
Session("sl.dlssg.options", Streamline, RefusedRoute, Text, FrameGeneration, "DLSS frame generation: mode, frames to generate"),
|
||||
Session("sl.dlssg.state", Streamline, RefusedRoute, Text, FrameGeneration, "DLSS frame generation: status, the most frames it can generate"),
|
||||
Sampled("sl.dlssg.frames_presented", Streamline, RefusedRoute, Count, FrameGeneration, "Frames DLSS frame generation presented, by its own count"),
|
||||
Sampled("sl.dlssg.vram_estimate", Streamline, RefusedRoute, Mebibytes, FrameGeneration, "DLSS frame generation's estimate of its video memory"),
|
||||
Session("sl.dlssd.options", Streamline, RefusedRoute, Text, Upscaling, "Ray reconstruction's options"),
|
||||
Session("sl.nis.options", Streamline, RefusedRoute, Text, Upscaling, "NVIDIA Image Scaling's options"),
|
||||
Session("sl.deepdvc.options", Streamline, RefusedRoute, Text, Upscaling, "RTX Dynamic Vibrance's options"),
|
||||
// A refused route (owner decision D133): the Overlay calling slReflexGetState itself breaks the thread
|
||||
// contract the vendor's header states.
|
||||
Session("sl.reflex.state", Streamline, RefusedRoute, Table, Latency, "Reflex through Streamline: availability and its frame reports"),
|
||||
Sampled("sl.pcl.markers", Streamline, RefusedRoute, Count, Latency, "PC-latency markers the game sets"),
|
||||
|
||||
// ---- Closed by a licence --------------------------------------------------------------------------------
|
||||
Session("ngx.parameters", Ngx, Licence, Table, Upscaling, "NGX parameters: the quality value, the DLSS hints"),
|
||||
|
||||
@@ -25,7 +25,10 @@ public enum AdvancedReach
|
||||
/// <summary>Needs a hook on a function its module exports; the hook is not built. No entry carries it since 0.1.0-beta.45.</summary>
|
||||
NewHook = 4,
|
||||
|
||||
/// <summary>A route nobody has proven safe: a spike decides, and the owner says go or no.</summary>
|
||||
/// <summary>
|
||||
/// A route nobody has proven safe: a spike decides, and the owner says go or no. No entry carries it since the
|
||||
/// owner closed Advanced metrics (D154, 2026-11-14): the ten that did are <see cref="RefusedRoute"/>.
|
||||
/// </summary>
|
||||
Spike = 5,
|
||||
|
||||
/// <summary>A source the project decided not to open (D103).</summary>
|
||||
@@ -57,4 +60,21 @@ public enum AdvancedReach
|
||||
/// instruction, and no hook is ever installed on a game's thread. Never read (owner decision D129).
|
||||
/// </summary>
|
||||
BeforeAttach = 13,
|
||||
|
||||
/// <summary>
|
||||
/// Read inside a game FrameLedger measures, while the session records Advanced metrics — but not from a call the
|
||||
/// game makes: the part inside the game asks the graphics driver itself, about once a second, for what the driver
|
||||
/// reports (Advanced metrics train C; owner decisions D132, D136, D138). Only where the game presents through
|
||||
/// Direct3D 12 and had already loaded the driver's library; <see cref="AdvancedDriverRead"/> says what became of
|
||||
/// it in a session.
|
||||
/// </summary>
|
||||
GameDriver = 14,
|
||||
|
||||
/// <summary>
|
||||
/// Reading it needs a route the project refused, whatever the source: a patch at an address learned at run time
|
||||
/// (what a game asks of Reflex is an argument of a function no module exports), or a call the vendor's own header
|
||||
/// forbids from a thread that is not the game's (owner decision D133), or a function of ours handed to the game in
|
||||
/// place of the vendor's (what a game sets and asks through Streamline's feature functions - D154). Never read.
|
||||
/// </summary>
|
||||
RefusedRoute = 15,
|
||||
}
|
||||
@@ -59,6 +59,21 @@ public sealed record AdvancedSources(
|
||||
|
||||
public AdvancedInGameCall? StreamlineShutdown { get; init; }
|
||||
|
||||
/// <summary>
|
||||
/// What became of the graphics driver's latency report (the <c>nvapi.reflex.</c> entries of reach
|
||||
/// <see cref="AdvancedReach.GameDriver"/>) in the session this describes (train C). Null where that is not a
|
||||
/// question - the machine's live state, a session not measured inside the game, a game the part inside it
|
||||
/// publishes nothing for - and in every row stored before.
|
||||
/// </summary>
|
||||
public AdvancedDriverRead? DriverLatency { get; init; }
|
||||
|
||||
/// <summary>
|
||||
/// The slowest call into the driver the session saw, in microseconds; null with <see cref="DriverLatency"/> and
|
||||
/// where no call was made. It is what tells a driver that held a call from a pause of the game's thread when
|
||||
/// <see cref="DriverLatency"/> is <see cref="AdvancedDriverRead.Slow"/>.
|
||||
/// </summary>
|
||||
public int? DriverLatencySlowestUs { get; init; }
|
||||
|
||||
/// <summary>Nothing asked yet.</summary>
|
||||
public static AdvancedSources Unknown { get; } = new(AdvancedSourceStatus.Unknown, NvapiCode: null, AdvancedSourceStatus.Unknown, AdvancedSourceStatus.Unknown);
|
||||
}
|
||||
@@ -38,8 +38,35 @@ public sealed class InGameAdvancedSampler
|
||||
/// <summary>FSR's own video memory as it answered the game, in mebibytes — a point for each second the game asked.</summary>
|
||||
public const string MemorySeries = AdvancedMetric.SeriesPrefix + "ffx.memory_usage";
|
||||
|
||||
/// <summary>
|
||||
/// The stem of the seven series of the driver's latency report (train C): <c>adv.nvapi.reflex.frame_report.</c>
|
||||
/// and one of <see cref="LatencySpans"/>. Each point is the mean, in microseconds, of the frames one read summed.
|
||||
/// </summary>
|
||||
public const string LatencySeriesStem = AdvancedMetric.SeriesPrefix + "nvapi.reflex.frame_report.";
|
||||
|
||||
/// <summary>
|
||||
/// The stem of the two series of the driver's own times (0.1.0-beta.48, D142): <c>adv.nvapi.reflex.gpu_times.</c>
|
||||
/// and one of <see cref="GpuTimes"/>. An entry of their own: they are figures the driver works out, not spans
|
||||
/// between two of its marks, and the seven spans stay within what one chart draws as lines.
|
||||
/// </summary>
|
||||
public const string GpuTimesSeriesStem = AdvancedMetric.SeriesPrefix + "nvapi.reflex.gpu_times.";
|
||||
|
||||
private const double _mebibyte = 1024.0 * 1024.0;
|
||||
|
||||
// The two groups of LatState that say which sleep switches were seen on and off.
|
||||
private const uint _sleepSeenBits =
|
||||
(FlAdvancedState.LatSleepBits << FlAdvancedState.LatSleepSeenOnShift) | (FlAdvancedState.LatSleepBits << FlAdvancedState.LatSleepSeenOffShift);
|
||||
|
||||
// The spans of a frame the driver reports, in the order the capture side publishes their sums.
|
||||
private static readonly string[] _latencySpans = ["simulation", "render_submit", "present", "driver", "os_queue", "gpu_render", "total"];
|
||||
|
||||
// The two times the driver works out itself: the card at work without its idle time, and one frame's GPU end to
|
||||
// the next's. In the order the capture side publishes their sums.
|
||||
private static readonly string[] _gpuTimes = ["active_render", "frame_time"];
|
||||
|
||||
// NV_GET_SLEEP_STATUS_PARAMS's five switches, by bit: the vendor's own names, shown as they are.
|
||||
private static readonly string[] _sleepSwitches = ["bLowLatencyMode", "bFsVrr", "bCplVsyncOn", "bUseGameSleep", "bFullscreenIFlip"];
|
||||
|
||||
// What the second row of a field of view over pi says (owner decision D128).
|
||||
private const string _notRadians = "not_radians";
|
||||
|
||||
@@ -79,9 +106,18 @@ public sealed class InGameAdvancedSampler
|
||||
/// switch seen over a session, the flags of the dispatch that have a name, "none", and what a field of view
|
||||
/// that cannot be radians is said to be (D128). A flag bit nobody named is <c>bit_N</c> and is shown as it is.
|
||||
/// </summary>
|
||||
public static IReadOnlyList<string> Tokens { get; } = ["on", "off", "on_and_off", "none", _notRadians, .. _flagTokens];
|
||||
public static IReadOnlyList<string> Tokens { get; } = ["on", "off", "on_and_off", "none", _notRadians, .. _flagTokens, .. _latencySpans, .. _gpuTimes];
|
||||
|
||||
/// <summary>The seven spans of a frame, as the last part of a series' name; the App translates each (<c>AdvToken_*</c>).</summary>
|
||||
public static IReadOnlyList<string> LatencySpans => _latencySpans;
|
||||
|
||||
/// <summary>The driver's two own times, as the last part of a series' name; the App translates each (<c>AdvToken_*</c>).</summary>
|
||||
public static IReadOnlyList<string> GpuTimes => _gpuTimes;
|
||||
|
||||
private InGameAdvanced? _last;
|
||||
private FlLatencyState _latencyState;
|
||||
private bool _latencyFrames;
|
||||
private uint _latencySlowestUs;
|
||||
private uint _memoryQueries;
|
||||
private FactKey _key;
|
||||
private uint _builtResets;
|
||||
@@ -98,6 +134,37 @@ public sealed class InGameAdvancedSampler
|
||||
public AdvancedInGameStatus Status(bool hooked) =>
|
||||
!hooked ? AdvancedInGameStatus.NotHooked : SawAnything ? AdvancedInGameStatus.Reading : AdvancedInGameStatus.NothingSeen;
|
||||
|
||||
/// <summary>
|
||||
/// What became of the driver's latency report (train C), for a session measured inside the game: null when it
|
||||
/// was not, and when the capture side said nothing about it - a game it publishes no Advanced metrics for.
|
||||
/// "Reported frames" wins over an error or a stop that came later: the series are there up to it, and the
|
||||
/// stops say themselves.
|
||||
/// </summary>
|
||||
public AdvancedDriverRead? DriverRead(bool hooked)
|
||||
{
|
||||
if (!hooked)
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
return _latencyState switch
|
||||
{
|
||||
FlLatencyState.NoDevice => AdvancedDriverRead.NoDirect3D12,
|
||||
FlLatencyState.NoModule => AdvancedDriverRead.NoModule,
|
||||
FlLatencyState.Refused => AdvancedDriverRead.Refused,
|
||||
FlLatencyState.NoGetter => AdvancedDriverRead.NoGetter,
|
||||
FlLatencyState.Reading => _latencyFrames ? AdvancedDriverRead.Read : AdvancedDriverRead.NothingReported,
|
||||
FlLatencyState.Error => _latencyFrames ? AdvancedDriverRead.Read : AdvancedDriverRead.Error,
|
||||
FlLatencyState.Slow => AdvancedDriverRead.Slow,
|
||||
FlLatencyState.Faulted => AdvancedDriverRead.Faulted,
|
||||
FlLatencyState.Stalled => AdvancedDriverRead.Stalled,
|
||||
_ => null,
|
||||
};
|
||||
}
|
||||
|
||||
/// <summary>The slowest call into the driver the publications carried, in microseconds; null while none was made.</summary>
|
||||
public int? DriverSlowestUs => _latencySlowestUs == 0 ? null : (int)_latencySlowestUs;
|
||||
|
||||
/// <summary>
|
||||
/// What became of the entries read from one call hooked only for Advanced metrics (0.1.0-beta.43):
|
||||
/// <paramref name="group"/> is the bit a publication carries once the call was read, <paramref name="hookedIn"/>
|
||||
@@ -156,12 +223,17 @@ public sealed class InGameAdvancedSampler
|
||||
|
||||
_last = published;
|
||||
ref readonly FlAdvancedState s = ref published.State;
|
||||
|
||||
// The driver's latency report first, and whatever the mask says: where that read stands is published even
|
||||
// when nothing was read, and it is not one of "the game's calls".
|
||||
List<AdvancedReading>? readings = TakeLatency(published);
|
||||
if (s.ValidMask == FlAdvancedValid.None)
|
||||
{
|
||||
return null;
|
||||
return readings;
|
||||
}
|
||||
|
||||
SawAnything = true;
|
||||
// "The game's calls were read" is about the game's calls: the driver's report is not one of them.
|
||||
SawAnything |= (s.ValidMask & ~FlAdvancedValid.Latency) != FlAdvancedValid.None;
|
||||
_everValid |= s.ValidMask;
|
||||
if (s.ValidMask.HasFlag(FlAdvancedValid.SlFeatures))
|
||||
{
|
||||
@@ -179,7 +251,7 @@ public sealed class InGameAdvancedSampler
|
||||
_builtResets = s.SlResets;
|
||||
}
|
||||
|
||||
var readings = new List<AdvancedReading>(2);
|
||||
readings ??= new List<AdvancedReading>(2);
|
||||
// The pair is drained by each publication: the dispatches of the second before it. A sum that saturated its
|
||||
// word is not a mean of anything.
|
||||
if (s.ValidMask.HasFlag(FlAdvancedValid.FfxUpscale) && s.FfxFrameTimeCount != 0 && s.FfxFrameTimeSumUs != uint.MaxValue)
|
||||
@@ -197,6 +269,51 @@ public sealed class InGameAdvancedSampler
|
||||
return readings.Count == 0 ? null : readings;
|
||||
}
|
||||
|
||||
// The ten latency words of a publication (07_IPC, region 5): the state and the slowest call are kept; the frames
|
||||
// and the sums are of ONE read and become one point a span - the mean over the frames that read summed. A span
|
||||
// some summed frame did not report has no point: without a sleep mode the driver reports no driver span at all.
|
||||
private List<AdvancedReading>? TakeLatency(InGameAdvanced published)
|
||||
{
|
||||
ref readonly FlAdvancedState s = ref published.State;
|
||||
var state = (FlLatencyState)(s.LatState & FlAdvancedState.LatStateMask);
|
||||
if (state != FlLatencyState.None)
|
||||
{
|
||||
_latencyState = state;
|
||||
}
|
||||
|
||||
_latencySlowestUs = Math.Max(_latencySlowestUs, s.LatReads >> 16);
|
||||
uint frames = s.LatFrames & 0xFFFFu;
|
||||
if (!s.ValidMask.HasFlag(FlAdvancedValid.Latency) || frames == 0)
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
_latencyFrames = true;
|
||||
uint[] sums = [s.LatSimulationSumUs, s.LatSubmitSumUs, s.LatPresentSumUs, s.LatDriverSumUs, s.LatOsQueueSumUs, s.LatGpuSumUs, s.LatTotalSumUs];
|
||||
var readings = new List<AdvancedReading>(sums.Length + _gpuTimes.Length);
|
||||
for (int span = 0; span < sums.Length; span++)
|
||||
{
|
||||
if (sums[span] != FlAdvancedState.LatSumNone)
|
||||
{
|
||||
readings.Add(new AdvancedReading(LatencySeriesStem + _latencySpans[span], sums[span] / (double)frames));
|
||||
}
|
||||
}
|
||||
|
||||
// The driver's two own times (D142): each the mean over the frames that gave one, so each has its own count.
|
||||
// A driver that gives neither - an older one leaves both zero - has no point here, and not a zero.
|
||||
uint[] gpuSums = [s.LatGpuActiveSumUs, s.LatGpuFrameSumUs];
|
||||
uint[] gpuFrames = [s.LatGpuCounts & 0xFFFFu, s.LatGpuCounts >> 16];
|
||||
for (int time = 0; time < gpuSums.Length; time++)
|
||||
{
|
||||
if (gpuFrames[time] != 0)
|
||||
{
|
||||
readings.Add(new AdvancedReading(GpuTimesSeriesStem + _gpuTimes[time], gpuSums[time] / (double)gpuFrames[time]));
|
||||
}
|
||||
}
|
||||
|
||||
return readings;
|
||||
}
|
||||
|
||||
private static List<AdvancedFact> Build(InGameAdvanced published)
|
||||
{
|
||||
var facts = new List<AdvancedFact>(11);
|
||||
@@ -230,9 +347,65 @@ public sealed class InGameAdvancedSampler
|
||||
AddStreamlineFeatureState(published, facts);
|
||||
}
|
||||
|
||||
if (published.State.ValidMask.HasFlag(FlAdvancedValid.Latency))
|
||||
{
|
||||
AddDriverSleepStatus(published, facts);
|
||||
}
|
||||
|
||||
return facts;
|
||||
}
|
||||
|
||||
// The driver's sleep status (train C): its five switches as seen over the session, by the vendor's own names, and
|
||||
// every frame-generation multiplier it gave (D144: a session that generated x2 and ended in a menu read 1 while
|
||||
// only the last one was kept). THE DRIVER'S WORDS: on the driver the probe ran against,
|
||||
// bLowLatencyMode read off for a device whose game had just switched low latency on (spike-notes §31) - so this
|
||||
// is never worded as "the game uses Reflex".
|
||||
private static void AddDriverSleepStatus(InGameAdvanced published, List<AdvancedFact> facts)
|
||||
{
|
||||
ref readonly FlAdvancedState s = ref published.State;
|
||||
uint on = (s.LatState >> FlAdvancedState.LatSleepSeenOnShift) & FlAdvancedState.LatSleepBits;
|
||||
uint off = (s.LatState >> FlAdvancedState.LatSleepSeenOffShift) & FlAdvancedState.LatSleepBits;
|
||||
if ((on | off) == 0)
|
||||
{
|
||||
return; // the report was read and the status never was
|
||||
}
|
||||
|
||||
var rows = new List<AdvancedRow>(_sleepSwitches.Length + 1);
|
||||
for (int bit = 0; bit < _sleepSwitches.Length; bit++)
|
||||
{
|
||||
// Bit 0 seen off, bit 1 seen on: the two bits AddSwitch reads.
|
||||
AddSwitch(rows, _sleepSwitches[bit], ((off >> bit) & 1u) | (((on >> bit) & 1u) << 1));
|
||||
}
|
||||
|
||||
if (MultipliersSeen(s.LatMultipliersSeen) is { } multipliers)
|
||||
{
|
||||
rows.Add(new AdvancedRow("fgMultiplier", multipliers));
|
||||
}
|
||||
|
||||
facts.Add(Fact("nvapi.reflex.sleep_status", AdvancedValue.OfRows(rows)));
|
||||
}
|
||||
|
||||
// The multipliers a session saw, lowest first: bit n of the word is multiplier n, bit 31 stands for 31 and more.
|
||||
// Bit 0 is a status that gave none, which is not a multiplier and is not listed.
|
||||
private static string? MultipliersSeen(uint seen)
|
||||
{
|
||||
var values = new List<string>(4);
|
||||
for (int multiplier = 1; multiplier < 31; multiplier++)
|
||||
{
|
||||
if ((seen & (1u << multiplier)) != 0)
|
||||
{
|
||||
values.Add(multiplier.ToString(CultureInfo.InvariantCulture));
|
||||
}
|
||||
}
|
||||
|
||||
if ((seen & (1u << 31)) != 0)
|
||||
{
|
||||
values.Add("\u2265 31");
|
||||
}
|
||||
|
||||
return values.Count == 0 ? null : string.Join(", ", values);
|
||||
}
|
||||
|
||||
// Whether Streamline says each feature is supported and loaded, and what the game did with it while the session
|
||||
// watched (0.1.0-beta.45): two facts, rows named as the versions' are. A refusal is the answer to "is it
|
||||
// supported", so the result is said by the vendor's own name whatever it is. A count that reached 15 stopped there.
|
||||
@@ -724,7 +897,8 @@ public sealed class InGameAdvancedSampler
|
||||
ulong SlFov,
|
||||
uint SlAspect,
|
||||
ulong SlFlags,
|
||||
ulong SlFeatures)
|
||||
ulong SlFeatures,
|
||||
ulong DriverSleep)
|
||||
{
|
||||
public static FactKey Of(InGameAdvanced published)
|
||||
{
|
||||
@@ -765,7 +939,10 @@ public sealed class InGameAdvancedSampler
|
||||
Pair(s.SlFovMinBits, s.SlFovMaxBits),
|
||||
s.SlAspectBits,
|
||||
Pair(s.SlFlagsSeenTrue, s.SlFlagsSeenFalse),
|
||||
FeaturesHash(published));
|
||||
FeaturesHash(published),
|
||||
// The driver's sleep status as seen and the multipliers seen: what the one latency fact is made of.
|
||||
// Not the LAST multiplier, which is no longer in the fact - it moves with every menu.
|
||||
s.ValidMask.HasFlag(FlAdvancedValid.Latency) ? Pair(s.LatState & _sleepSeenBits, s.LatMultipliersSeen) : 0UL);
|
||||
}
|
||||
|
||||
// The feature slots as one number (FNV-1a over the words of the slots in use): an answer that arrives, or one
|
||||
|
||||
@@ -0,0 +1,20 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
using System.Diagnostics.CodeAnalysis;
|
||||
using FrameLedger.Application.Telemetry;
|
||||
|
||||
namespace FrameLedger.Application.Input;
|
||||
|
||||
/// <summary>
|
||||
/// One session's view of <see cref="IInputDevices"/>: the slices in which a window of the session's own game was in
|
||||
/// front, added up between two reads. Several sessions can run at once; each has its own.
|
||||
/// </summary>
|
||||
public interface IInputActivitySource : IDisposable
|
||||
{
|
||||
/// <summary>The processes whose windows count as the session's game. Called from the session's loop.</summary>
|
||||
void Follow(GameProcess target);
|
||||
|
||||
/// <summary>What was seen since the last read; false when the reader took no slice since then. Called from the telemetry thread, and never throws into it.</summary>
|
||||
bool TryRead([NotNullWhen(true)] out InputReading? reading);
|
||||
}
|
||||
@@ -0,0 +1,38 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
namespace FrameLedger.Application.Input;
|
||||
|
||||
/// <summary>
|
||||
/// The Windows calls the input reader makes, behind one interface (<c>21_INPUT_DEVICES</c> §What is read): raw input
|
||||
/// for game controllers, XInput, the time of the last keyboard or mouse input, the window in front. Everything here
|
||||
/// reads; nothing writes to a device, and nothing asks about a keyboard or a mouse beyond that one time
|
||||
/// (<c>tools/input-readonly-check.ps1</c> holds the calls behind it to a list).
|
||||
/// </summary>
|
||||
/// <remarks>Every member is called on the reader's own thread, the one that called <see cref="Open"/>.</remarks>
|
||||
public interface IInputBackend : IDisposable
|
||||
{
|
||||
/// <summary>Makes what the reader needs on the calling thread; returns whether Windows accepted the registration for game controllers' reports.</summary>
|
||||
bool Open();
|
||||
|
||||
/// <summary>Hands over what arrived since the last call: the controllers that came and went, then their reports.</summary>
|
||||
void Drain(IInputBackendSink sink);
|
||||
|
||||
/// <summary>Whether XInput's library is there to ask.</summary>
|
||||
bool XInputAvailable { get; }
|
||||
|
||||
/// <summary>The state of one of XInput's four pads; false when it is not connected.</summary>
|
||||
bool TryReadPad(int slot, out XInputReading pad);
|
||||
|
||||
/// <summary>Whether the pad is wireless, and its battery; false when XInput did not answer.</summary>
|
||||
bool TryReadPadDetails(int slot, out XInputDetails details);
|
||||
|
||||
/// <summary>The time of the last keyboard or mouse input in the user's session, as Windows' tick count; false when Windows did not give it.</summary>
|
||||
bool TryReadLastInputTick(out uint tick);
|
||||
|
||||
/// <summary>The process whose window is in front; 0 when there is none.</summary>
|
||||
uint ForegroundProcessId();
|
||||
|
||||
/// <summary>The processor time the calling thread has used, in milliseconds.</summary>
|
||||
long ThreadCpuMs();
|
||||
}
|
||||
@@ -0,0 +1,17 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
namespace FrameLedger.Application.Input;
|
||||
|
||||
/// <summary>What <see cref="IInputBackend.Drain"/> hands over. A device is named by the handle Windows gave it for as long as it is connected: a key, never stored.</summary>
|
||||
public interface IInputBackendSink
|
||||
{
|
||||
/// <summary>A game controller is there: at the start, or newly connected.</summary>
|
||||
void Arrived(nint device, RawController controller);
|
||||
|
||||
/// <summary>It left.</summary>
|
||||
void Removed(nint device);
|
||||
|
||||
/// <summary>One input report of a controller, its report id first, at the length Windows hands the device's reports over.</summary>
|
||||
void Report(nint device, ReadOnlySpan<byte> report);
|
||||
}
|
||||
@@ -0,0 +1,15 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
namespace FrameLedger.Application.Input;
|
||||
|
||||
/// <summary>
|
||||
/// The Agent's one reader of game controllers and of keyboard-and-mouse activity (owner decisions of 2026-11-14,
|
||||
/// <c>21_INPUT_DEVICES</c>). It reads from outside every game - nothing is hooked, nothing in a game is opened - and
|
||||
/// only while a session holds a view of it: with no session it does not run at all.
|
||||
/// </summary>
|
||||
public interface IInputDevices
|
||||
{
|
||||
/// <summary>One session's view of the reader. The reader runs from the first view opened to the last disposed.</summary>
|
||||
IInputActivitySource Open();
|
||||
}
|
||||
@@ -0,0 +1,39 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
using FrameLedger.Domain.Input;
|
||||
|
||||
namespace FrameLedger.Application.Input;
|
||||
|
||||
/// <summary>
|
||||
/// One game controller the Agent saw, as far as a session keeps it (<c>21_INPUT_DEVICES</c> §Who a controller is): its
|
||||
/// maker and model by their USB ids, how it is connected, and whether it is one of XInput's four pads.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <b>What is not here is not read:</b> no serial number, no Bluetooth address, no device path. Two pads of one model
|
||||
/// on one kind of connection cannot be told apart across a reconnect, and are not.
|
||||
/// </remarks>
|
||||
public sealed record InputDevice
|
||||
{
|
||||
/// <summary>The reader's own number for the device, the same for as long as the reader runs. It names nothing outside the Agent.</summary>
|
||||
public required int Id { get; init; }
|
||||
|
||||
public ControllerFamily Family { get; init; }
|
||||
|
||||
/// <summary>The USB vendor id; 0 for one of XInput's pads that nothing could name.</summary>
|
||||
public int VendorId { get; init; }
|
||||
|
||||
/// <summary>The USB product id; 0 with a <see cref="VendorId"/> of 0.</summary>
|
||||
public int ProductId { get; init; }
|
||||
|
||||
public ControllerConnection Connection { get; init; }
|
||||
|
||||
/// <summary>Whether the ids are those of a pad a program presents - Steam's virtual gamepad - rather than one a player holds.</summary>
|
||||
public bool IsVirtual { get; init; }
|
||||
|
||||
/// <summary>Which of XInput's four pads this is (0-3); null for a controller Windows does not present through XInput.</summary>
|
||||
public int? XInputSlot { get; init; }
|
||||
|
||||
/// <summary>The model's product name, or null for ids this build does not list.</summary>
|
||||
public string? Model => ControllerCatalog.ModelOf(VendorId, ProductId);
|
||||
}
|
||||
@@ -0,0 +1,17 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
using System.Runtime.InteropServices;
|
||||
using FrameLedger.Domain.Input;
|
||||
|
||||
namespace FrameLedger.Application.Input;
|
||||
|
||||
/// <summary>One controller during one tick.</summary>
|
||||
/// <param name="DeviceId">The <see cref="InputDevice.Id"/> it is about.</param>
|
||||
/// <param name="Connected">Whether it was connected at the end of the tick.</param>
|
||||
/// <param name="ActiveMs">The time it was in use while the game was in front and the session was not paused.</param>
|
||||
/// <param name="Battery">Its battery at the tick's last reading, when it reported one.</param>
|
||||
/// <param name="Connects">How many times it connected during the tick. Being there when the session began is not a connection.</param>
|
||||
/// <param name="Disconnects">How many times it disconnected during the tick.</param>
|
||||
[StructLayout(LayoutKind.Auto)]
|
||||
public readonly record struct InputDeviceReading(int DeviceId, bool Connected, int ActiveMs, BatteryReading? Battery, int Connects, int Disconnects);
|
||||
@@ -0,0 +1,85 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
namespace FrameLedger.Application.Input;
|
||||
|
||||
/// <summary>
|
||||
/// What each source of the input reader did, as counts (<c>21_INPUT_DEVICES</c> §What the reader says about itself).
|
||||
/// The reader was built without a controller to try it on (owner decision, 2026-11-14), so a session carries the
|
||||
/// evidence of what answered on the PC it ran on: whether Windows accepted the registration, how many reports came,
|
||||
/// whether XInput said anything while the Agent was in the background. Counts only - nothing here names a device.
|
||||
/// </summary>
|
||||
public sealed record InputHealth
|
||||
{
|
||||
/// <summary>Whether Windows accepted the registration for game controllers' reports.</summary>
|
||||
public bool RawInputRegistered { get; init; }
|
||||
|
||||
/// <summary>Reports of game controllers received.</summary>
|
||||
public long RawReports { get; init; }
|
||||
|
||||
/// <summary>Reports that could not be read: a layout the parser does not know, or one Windows' own parser refused.</summary>
|
||||
public long RawReportsUnread { get; init; }
|
||||
|
||||
/// <summary>Whether XInput's library was there to ask.</summary>
|
||||
public bool XInputAvailable { get; init; }
|
||||
|
||||
/// <summary>States XInput returned for a connected pad.</summary>
|
||||
public long XInputReads { get; init; }
|
||||
|
||||
/// <summary>
|
||||
/// Slices in which a controller Windows presents through XInput sent reports that are a pad in use while XInput's
|
||||
/// own state said nothing was. More than a handful means XInput does not answer a program in the background on
|
||||
/// this PC, and its pads were then read from their reports alone.
|
||||
/// </summary>
|
||||
public long XInputSilent { get; init; }
|
||||
|
||||
/// <summary>Whether Windows gave the time of the last keyboard or mouse input.</summary>
|
||||
public bool LastInputAvailable { get; init; }
|
||||
|
||||
/// <summary>Slices the reader took.</summary>
|
||||
public long Slices { get; init; }
|
||||
|
||||
/// <summary>Processor time the reader's thread used, in milliseconds.</summary>
|
||||
public long ThreadCpuMs { get; init; }
|
||||
|
||||
/// <summary>Slices that failed with an error and were skipped.</summary>
|
||||
public int Faults { get; init; }
|
||||
|
||||
/// <summary>What happened since <paramref name="start"/>: the counts less the ones it holds; the yes-or-no answers are the later ones.</summary>
|
||||
public InputHealth Since(InputHealth start)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(start);
|
||||
return this with
|
||||
{
|
||||
RawReports = RawReports - start.RawReports,
|
||||
RawReportsUnread = RawReportsUnread - start.RawReportsUnread,
|
||||
XInputReads = XInputReads - start.XInputReads,
|
||||
XInputSilent = XInputSilent - start.XInputSilent,
|
||||
Slices = Slices - start.Slices,
|
||||
ThreadCpuMs = ThreadCpuMs - start.ThreadCpuMs,
|
||||
Faults = Faults - start.Faults,
|
||||
};
|
||||
}
|
||||
|
||||
/// <summary>The sources that answered, as <c>sessions.input_source</c> stores them: <c>rawinput</c>, <c>xinput</c> and <c>lastinput</c>, joined by <c>+</c>; empty when none did.</summary>
|
||||
public string Sources()
|
||||
{
|
||||
var parts = new List<string>(3);
|
||||
if (RawInputRegistered)
|
||||
{
|
||||
parts.Add("rawinput");
|
||||
}
|
||||
|
||||
if (XInputAvailable)
|
||||
{
|
||||
parts.Add("xinput");
|
||||
}
|
||||
|
||||
if (LastInputAvailable)
|
||||
{
|
||||
parts.Add("lastinput");
|
||||
}
|
||||
|
||||
return string.Join('+', parts);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,84 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
using FrameLedger.Domain.Input;
|
||||
|
||||
namespace FrameLedger.Application.Input;
|
||||
|
||||
/// <summary>
|
||||
/// The words a ledger stores for a controller's family, its connection and its battery (<c>06_DATA_MODEL</c>
|
||||
/// §<c>sessions.input_devices</c>). They are data, not text shown to anyone: the App has its own, translated, and a
|
||||
/// word here is never renamed once a release has written it.
|
||||
/// </summary>
|
||||
public static class InputNames
|
||||
{
|
||||
public const string Other = "other";
|
||||
|
||||
public const string Unknown = "unknown";
|
||||
|
||||
public const string None = "none";
|
||||
|
||||
public static string Of(ControllerFamily family) => family switch
|
||||
{
|
||||
ControllerFamily.Xbox => "xbox",
|
||||
ControllerFamily.PlayStation => "playstation",
|
||||
ControllerFamily.Nintendo => "nintendo",
|
||||
_ => Other,
|
||||
};
|
||||
|
||||
public static ControllerFamily FamilyOf(string? name) => name switch
|
||||
{
|
||||
"xbox" => ControllerFamily.Xbox,
|
||||
"playstation" => ControllerFamily.PlayStation,
|
||||
"nintendo" => ControllerFamily.Nintendo,
|
||||
_ => ControllerFamily.Other,
|
||||
};
|
||||
|
||||
public static string Of(ControllerConnection connection) => connection switch
|
||||
{
|
||||
ControllerConnection.Usb => "usb",
|
||||
ControllerConnection.Bluetooth => "bluetooth",
|
||||
ControllerConnection.Wireless => "wireless",
|
||||
_ => Unknown,
|
||||
};
|
||||
|
||||
public static ControllerConnection ConnectionOf(string? name) => name switch
|
||||
{
|
||||
"usb" => ControllerConnection.Usb,
|
||||
"bluetooth" => ControllerConnection.Bluetooth,
|
||||
"wireless" => ControllerConnection.Wireless,
|
||||
_ => ControllerConnection.Unknown,
|
||||
};
|
||||
|
||||
public static string Of(BatteryState state) => state switch
|
||||
{
|
||||
BatteryState.Discharging => "discharging",
|
||||
BatteryState.Charging => "charging",
|
||||
BatteryState.Full => "full",
|
||||
BatteryState.Wired => "wired",
|
||||
_ => Unknown,
|
||||
};
|
||||
|
||||
public static BatteryState StateOf(string? name) => name switch
|
||||
{
|
||||
"discharging" => BatteryState.Discharging,
|
||||
"charging" => BatteryState.Charging,
|
||||
"full" => BatteryState.Full,
|
||||
"wired" => BatteryState.Wired,
|
||||
_ => BatteryState.Unknown,
|
||||
};
|
||||
|
||||
public static string Of(BatteryScale scale) => scale switch
|
||||
{
|
||||
BatteryScale.FourLevels => "levels",
|
||||
BatteryScale.Percent => "percent",
|
||||
_ => None,
|
||||
};
|
||||
|
||||
public static BatteryScale ScaleOf(string? name) => name switch
|
||||
{
|
||||
"levels" => BatteryScale.FourLevels,
|
||||
"percent" => BatteryScale.Percent,
|
||||
_ => BatteryScale.None,
|
||||
};
|
||||
}
|
||||
@@ -0,0 +1,373 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
using FrameLedger.Domain.Input;
|
||||
|
||||
namespace FrameLedger.Application.Input;
|
||||
|
||||
/// <summary>
|
||||
/// The input reader itself (<c>21_INPUT_DEVICES</c> §The reader): about ten times a second it takes what Windows has
|
||||
/// to say - the controllers' reports that arrived, XInput's four pads, the time of the last keyboard or mouse input,
|
||||
/// the window in front - and makes one <see cref="InputSlice"/> of it. It is the same for every session running; whose
|
||||
/// game a slice counts for is <see cref="InputTickAccumulator"/>'s to decide.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// <b>What a controller is here.</b> Each of XInput's pads that is connected is one; each controller Windows does not
|
||||
/// present through XInput is one. A device Windows presents through XInput is ALSO seen by raw input, and is not a
|
||||
/// second controller: it gives the pads their name, when that cannot be mistaken, and is the witness of the next
|
||||
/// paragraph.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <b>XInput in the background is not documented</b>: Microsoft's page for <c>XInputEnable</c> says that since
|
||||
/// Windows 10 the system switches a program's controller input by its window's focus, and the Agent has no window in
|
||||
/// front, ever. So the reader watches for it. A slice in which an XInput-class device's own reports changed while no
|
||||
/// pad's packet number moved - not in this slice nor the one before - is counted
|
||||
/// (<see cref="InputHealth.XInputSilent"/>). Once there are <see cref="SilentBeforeFallback"/> of them and XInput has
|
||||
/// never once been seen to move, XInput is taken to be answering nothing here, and from then on such a slice counts
|
||||
/// the lowest connected pad as in use: its reports changed, which a pad at rest does not do. That is coarser than
|
||||
/// XInput's own dead zones - a drifting stick counts - and it is used only where the better source is silent.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <b>Which controllers are read for use.</b> XInput's pads, and a DualSense by its own reports
|
||||
/// (<see cref="DualSenseReport"/>). Any other controller is listed, with its connections and drops, and is never "in
|
||||
/// use": its report layout is not known to this build, and a guess would be a made-up number.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public sealed class InputReader : IInputBackendSink
|
||||
{
|
||||
/// <summary>XInput's four pads.</summary>
|
||||
public const int Slots = 4;
|
||||
|
||||
/// <summary>A pad that is not connected is asked about once in this many slices - XInput looks for a device each time it is asked about an empty one - and at once when a controller arrives or leaves.</summary>
|
||||
public const int ProbeEverySlices = 20;
|
||||
|
||||
/// <summary>A connected pad's battery is asked for once in this many slices.</summary>
|
||||
public const int DetailsEverySlices = 50;
|
||||
|
||||
/// <summary>How many silent slices, with XInput never seen to move, before a device's own reports stand in for it.</summary>
|
||||
public const int SilentBeforeFallback = 10;
|
||||
|
||||
/// <summary>The number the first controller that is not one of XInput's gets; the pads are 1 to 4.</summary>
|
||||
private const int _firstRawId = 16;
|
||||
|
||||
private readonly IInputBackend _backend;
|
||||
private readonly Dictionary<nint, Raw> _raw = [];
|
||||
private readonly Dictionary<(RawController Controller, int Instance), int> _rawIds = [];
|
||||
private readonly Pad[] _pads = [new(0), new(1), new(2), new(3)];
|
||||
private bool _registered;
|
||||
private bool _lastInputAvailable;
|
||||
private uint? _lastInputTick;
|
||||
private bool _probeNow = true;
|
||||
private bool _renamePads = true;
|
||||
private bool _movedLastSlice;
|
||||
private bool _xinputEverMoved;
|
||||
private long _slices;
|
||||
private long _rawReports;
|
||||
private long _rawReportsUnread;
|
||||
private long _xinputReads;
|
||||
private long _xinputSilent;
|
||||
private int _faults;
|
||||
|
||||
public InputReader(IInputBackend backend) => _backend = backend ?? throw new ArgumentNullException(nameof(backend));
|
||||
|
||||
/// <summary>
|
||||
/// The only device classes the reader registers raw input for: HID usage page 1 (generic desktop), usages 4
|
||||
/// (joystick) and 5 (gamepad). Never 2 (mouse) or 6 (keyboard): what is known of those is one time, from
|
||||
/// <see cref="IInputBackend.TryReadLastInputTick"/> (owner decision D158).
|
||||
/// </summary>
|
||||
public static IReadOnlyList<(ushort UsagePage, ushort Usage)> RegisteredUsages { get; } = [(1, 4), (1, 5)];
|
||||
|
||||
/// <summary>Opens the backend on the calling thread, which is the one every <see cref="Slice"/> must then be called on.</summary>
|
||||
public void Open() => _registered = _backend.Open();
|
||||
|
||||
/// <summary>A slice that threw is counted and skipped.</summary>
|
||||
public void Fault() => _faults++;
|
||||
|
||||
/// <summary>What Windows has to say since the slice before, <paramref name="elapsedMs"/> ago.</summary>
|
||||
public InputSlice Slice(int elapsedMs)
|
||||
{
|
||||
_slices++;
|
||||
foreach (Raw raw in _raw.Values)
|
||||
{
|
||||
raw.Active = false;
|
||||
raw.Changed = false;
|
||||
}
|
||||
|
||||
_backend.Drain(this);
|
||||
bool moved = ReadPads();
|
||||
WatchForSilence(moved);
|
||||
if (_renamePads)
|
||||
{
|
||||
NamePads();
|
||||
}
|
||||
|
||||
bool keyboardMouse = false;
|
||||
if (_backend.TryReadLastInputTick(out uint tick))
|
||||
{
|
||||
_lastInputAvailable = true;
|
||||
keyboardMouse = _lastInputTick is { } before && tick != before;
|
||||
_lastInputTick = tick;
|
||||
}
|
||||
|
||||
var devices = new List<InputSliceDevice>(Slots + _raw.Count);
|
||||
foreach (Pad pad in _pads)
|
||||
{
|
||||
if (pad.Connected)
|
||||
{
|
||||
devices.Add(new InputSliceDevice(pad.Device, pad.Active, pad.Details is { } d ? XInputPad.Battery(d.BatteryType, d.BatteryLevel) : null));
|
||||
}
|
||||
}
|
||||
|
||||
foreach (Raw raw in _raw.Values.Where(static r => !r.Controller.XInputClass).OrderBy(static r => r.Device.Id))
|
||||
{
|
||||
devices.Add(new InputSliceDevice(raw.Device, raw.Active, raw.Battery));
|
||||
}
|
||||
|
||||
return new InputSlice
|
||||
{
|
||||
ElapsedMs = Math.Max(0, elapsedMs),
|
||||
ForegroundProcessId = _backend.ForegroundProcessId(),
|
||||
KeyboardMouseActive = keyboardMouse,
|
||||
VirtualPad = _raw.Values.Any(static r => r.Controller is { XInputClass: true, IsVirtual: true }),
|
||||
Devices = devices,
|
||||
Health = new InputHealth
|
||||
{
|
||||
RawInputRegistered = _registered,
|
||||
RawReports = _rawReports,
|
||||
RawReportsUnread = _rawReportsUnread,
|
||||
XInputAvailable = _backend.XInputAvailable,
|
||||
XInputReads = _xinputReads,
|
||||
XInputSilent = _xinputSilent,
|
||||
LastInputAvailable = _lastInputAvailable,
|
||||
Slices = _slices,
|
||||
ThreadCpuMs = _backend.ThreadCpuMs(),
|
||||
Faults = _faults,
|
||||
},
|
||||
};
|
||||
}
|
||||
|
||||
void IInputBackendSink.Arrived(nint device, RawController controller)
|
||||
{
|
||||
if (_raw.TryGetValue(device, out Raw? known) && known.Controller == controller)
|
||||
{
|
||||
// Windows names the controllers that are already there when the registration is made, and the reader has
|
||||
// asked for the list as well: the same device twice is one device.
|
||||
return;
|
||||
}
|
||||
|
||||
int id = 0;
|
||||
if (!controller.XInputClass)
|
||||
{
|
||||
int instance = _raw.Values.Count(r => r.Controller == controller);
|
||||
if (!_rawIds.TryGetValue((controller, instance), out id))
|
||||
{
|
||||
id = _firstRawId + _rawIds.Count;
|
||||
_rawIds[(controller, instance)] = id;
|
||||
}
|
||||
}
|
||||
|
||||
_raw[device] = new Raw(controller, new InputDevice
|
||||
{
|
||||
Id = id,
|
||||
Family = ControllerCatalog.FamilyOf(controller.VendorId, xinput: false),
|
||||
VendorId = controller.VendorId,
|
||||
ProductId = controller.ProductId,
|
||||
Connection = controller.Connection,
|
||||
});
|
||||
DevicesChanged(controller);
|
||||
}
|
||||
|
||||
void IInputBackendSink.Removed(nint device)
|
||||
{
|
||||
if (_raw.Remove(device, out Raw? gone))
|
||||
{
|
||||
DevicesChanged(gone.Controller);
|
||||
}
|
||||
}
|
||||
|
||||
void IInputBackendSink.Report(nint device, ReadOnlySpan<byte> report)
|
||||
{
|
||||
_rawReports++;
|
||||
if (!_raw.TryGetValue(device, out Raw? raw))
|
||||
{
|
||||
_rawReportsUnread++;
|
||||
return;
|
||||
}
|
||||
|
||||
if (raw.Controller.XInputClass)
|
||||
{
|
||||
// The witness only: did the device say something new. What it said is XInput's to tell.
|
||||
raw.Changed |= raw.Last is not null && !report.SequenceEqual(raw.Last);
|
||||
if (raw.Last is null || raw.Last.Length != report.Length)
|
||||
{
|
||||
raw.Last = report.ToArray();
|
||||
}
|
||||
else
|
||||
{
|
||||
report.CopyTo(raw.Last);
|
||||
}
|
||||
}
|
||||
else if (raw.Controller.IsDualSense)
|
||||
{
|
||||
if (DualSenseReport.TryRead(report, raw.Controller.Connection == ControllerConnection.Bluetooth, out bool active, out BatteryReading? battery))
|
||||
{
|
||||
raw.Active |= active;
|
||||
raw.Battery = battery ?? raw.Battery;
|
||||
}
|
||||
else
|
||||
{
|
||||
_rawReportsUnread++;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private void DevicesChanged(RawController controller)
|
||||
{
|
||||
if (controller.XInputClass)
|
||||
{
|
||||
_probeNow = true;
|
||||
_renamePads = true;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>Asks XInput about its pads; returns whether any connected pad's packet number moved since the slice before.</summary>
|
||||
private bool ReadPads()
|
||||
{
|
||||
bool moved = false;
|
||||
bool probe = _probeNow || _slices % ProbeEverySlices == 1;
|
||||
_probeNow = false;
|
||||
foreach (Pad pad in _pads)
|
||||
{
|
||||
pad.Active = false;
|
||||
if (!_backend.XInputAvailable || (!pad.Connected && !probe))
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
if (!_backend.TryReadPad(pad.Slot, out XInputReading state))
|
||||
{
|
||||
if (pad.Connected)
|
||||
{
|
||||
pad.Connected = false;
|
||||
pad.Details = null;
|
||||
_renamePads = true;
|
||||
}
|
||||
|
||||
continue;
|
||||
}
|
||||
|
||||
_xinputReads++;
|
||||
if (!pad.Connected)
|
||||
{
|
||||
pad.Connected = true;
|
||||
pad.Details = null;
|
||||
_renamePads = true;
|
||||
}
|
||||
else if (state.Packet != pad.Packet)
|
||||
{
|
||||
moved = true;
|
||||
}
|
||||
|
||||
pad.Packet = state.Packet;
|
||||
pad.Active = XInputPad.IsActive(state.Buttons, state.LeftTrigger, state.RightTrigger, state.ThumbLx, state.ThumbLy, state.ThumbRx, state.ThumbRy);
|
||||
if (pad.Details is null || _slices - pad.DetailsAt >= DetailsEverySlices)
|
||||
{
|
||||
pad.DetailsAt = _slices;
|
||||
if (_backend.TryReadPadDetails(pad.Slot, out XInputDetails details))
|
||||
{
|
||||
_renamePads |= pad.Details?.Wireless != details.Wireless;
|
||||
pad.Details = details;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return moved;
|
||||
}
|
||||
|
||||
private void WatchForSilence(bool moved)
|
||||
{
|
||||
_xinputEverMoved |= moved;
|
||||
bool deviceSpoke = _raw.Values.Any(static r => r.Controller.XInputClass && r.Changed);
|
||||
if (deviceSpoke && !moved && !_movedLastSlice && !_pads.Any(static p => p is { Connected: true, Active: true }))
|
||||
{
|
||||
_xinputSilent++;
|
||||
if (!_xinputEverMoved && _xinputSilent >= SilentBeforeFallback && _pads.FirstOrDefault(static p => p.Connected) is { } lowest)
|
||||
{
|
||||
lowest.Active = true;
|
||||
}
|
||||
}
|
||||
|
||||
_movedLastSlice = moved;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// What each connected pad is. XInput does not say which device a pad is, so a pad is named only when it cannot be
|
||||
/// another: every XInput-class device a player could hold has the same two ids, or the only ones there are
|
||||
/// Steam's. Otherwise it is "one of XInput's pads" - the Xbox family, no ids, no model.
|
||||
/// </summary>
|
||||
private void NamePads()
|
||||
{
|
||||
_renamePads = false;
|
||||
RawController[] presented = [.. _raw.Values.Where(static r => r.Controller.XInputClass).Select(static r => r.Controller)];
|
||||
RawController[] held = [.. presented.Where(static c => !c.IsVirtual)];
|
||||
RawController? name = held.Length > 0
|
||||
? held.All(c => c.VendorId == held[0].VendorId && c.ProductId == held[0].ProductId) ? held[0] : null
|
||||
: presented.Length > 0 ? presented[0] : null;
|
||||
bool bluetooth = name is not null && held.Length > 0 && held.All(static c => c.Connection == ControllerConnection.Bluetooth);
|
||||
foreach (Pad pad in _pads)
|
||||
{
|
||||
pad.Device = new InputDevice
|
||||
{
|
||||
Id = pad.Slot + 1,
|
||||
XInputSlot = pad.Slot,
|
||||
Family = ControllerCatalog.FamilyOf(name?.VendorId ?? 0, xinput: true),
|
||||
VendorId = name?.VendorId ?? 0,
|
||||
ProductId = name?.ProductId ?? 0,
|
||||
IsVirtual = name?.IsVirtual ?? false,
|
||||
Connection = bluetooth
|
||||
? ControllerConnection.Bluetooth
|
||||
: pad.Details switch
|
||||
{
|
||||
{ Wireless: true } => ControllerConnection.Wireless,
|
||||
{ } => ControllerConnection.Usb,
|
||||
_ => ControllerConnection.Unknown,
|
||||
},
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>One of XInput's pads.</summary>
|
||||
private sealed class Pad(int slot)
|
||||
{
|
||||
public int Slot { get; } = slot;
|
||||
|
||||
public bool Connected { get; set; }
|
||||
|
||||
public uint Packet { get; set; }
|
||||
|
||||
public bool Active { get; set; }
|
||||
|
||||
public XInputDetails? Details { get; set; }
|
||||
|
||||
public long DetailsAt { get; set; }
|
||||
|
||||
public InputDevice Device { get; set; } = new() { Id = slot + 1, XInputSlot = slot, Family = ControllerFamily.Xbox };
|
||||
}
|
||||
|
||||
/// <summary>A controller raw input named.</summary>
|
||||
private sealed class Raw(RawController controller, InputDevice device)
|
||||
{
|
||||
public RawController Controller { get; } = controller;
|
||||
|
||||
public InputDevice Device { get; } = device;
|
||||
|
||||
public bool Active { get; set; }
|
||||
|
||||
public bool Changed { get; set; }
|
||||
|
||||
public BatteryReading? Battery { get; set; }
|
||||
|
||||
public byte[]? Last { get; set; }
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,45 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
namespace FrameLedger.Application.Input;
|
||||
|
||||
/// <summary>
|
||||
/// What the input reader saw for one session during one tick of the telemetry poller (<c>03_METRICS</c> §Input): how
|
||||
/// the time the game was in front divides between a controller, the keyboard and mouse, both and neither, and each
|
||||
/// controller's part in it.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// It holds times and counts. Which button, where a stick was, which key, what was typed and where the mouse was are
|
||||
/// not in it because the reader never keeps them (<c>21_INPUT_DEVICES</c> §What is never read).
|
||||
/// </remarks>
|
||||
public sealed record InputReading
|
||||
{
|
||||
/// <summary>The time the tick covers: every slice, in front or not, paused or not. What a battery level and a connection are timed by.</summary>
|
||||
public int SpanMs { get; init; }
|
||||
|
||||
/// <summary>Of <see cref="SpanMs"/>, the time the session was not paused.</summary>
|
||||
public int ObservedMs { get; init; }
|
||||
|
||||
/// <summary>Of <see cref="ObservedMs"/>, the time a window of the game was in front. The four below add up to it.</summary>
|
||||
public int ForegroundMs { get; init; }
|
||||
|
||||
public int ControllerMs { get; init; }
|
||||
|
||||
public int KeyboardMouseMs { get; init; }
|
||||
|
||||
public int BothMs { get; init; }
|
||||
|
||||
public int IdleMs { get; init; }
|
||||
|
||||
/// <summary>Whether a pad a program presents - Steam's virtual gamepad - was among XInput's pads during the tick.</summary>
|
||||
public bool VirtualPad { get; init; }
|
||||
|
||||
/// <summary>The controllers that were connected at some moment of the tick.</summary>
|
||||
public IReadOnlyList<InputDeviceReading> Devices { get; init; } = [];
|
||||
|
||||
/// <summary>What each controller in <see cref="Devices"/> is. A reading stands alone: it names every device it counts.</summary>
|
||||
public IReadOnlyList<InputDevice> Table { get; init; } = [];
|
||||
|
||||
/// <summary>What the reader's sources did since the session began reading.</summary>
|
||||
public InputHealth Health { get; init; } = new();
|
||||
}
|
||||
@@ -0,0 +1,30 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
namespace FrameLedger.Application.Input;
|
||||
|
||||
/// <summary>
|
||||
/// What the input reader saw of the whole PC in one slice - about a tenth of a second (<c>21_INPUT_DEVICES</c> §The
|
||||
/// reader). It is the same for every session running: which session a slice counts for is decided by whose window was
|
||||
/// in front (<see cref="InputTickAccumulator"/>).
|
||||
/// </summary>
|
||||
public sealed record InputSlice
|
||||
{
|
||||
/// <summary>The time since the slice before.</summary>
|
||||
public int ElapsedMs { get; init; }
|
||||
|
||||
/// <summary>The process whose window was in front; 0 when Windows named none.</summary>
|
||||
public uint ForegroundProcessId { get; init; }
|
||||
|
||||
/// <summary>Whether Windows' time of the last keyboard or mouse input moved during the slice.</summary>
|
||||
public bool KeyboardMouseActive { get; init; }
|
||||
|
||||
/// <summary>Whether a pad a program presents was among XInput's pads.</summary>
|
||||
public bool VirtualPad { get; init; }
|
||||
|
||||
/// <summary>The controllers connected during the slice.</summary>
|
||||
public IReadOnlyList<InputSliceDevice> Devices { get; init; } = [];
|
||||
|
||||
/// <summary>What the reader's sources did since the reader started.</summary>
|
||||
public InputHealth Health { get; init; } = new();
|
||||
}
|
||||
@@ -0,0 +1,14 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
using System.Runtime.InteropServices;
|
||||
using FrameLedger.Domain.Input;
|
||||
|
||||
namespace FrameLedger.Application.Input;
|
||||
|
||||
/// <summary>One connected controller during one slice.</summary>
|
||||
/// <param name="Device">What it is.</param>
|
||||
/// <param name="Active">Whether anything on it was in use during the slice.</param>
|
||||
/// <param name="Battery">Its battery, when it reported one.</param>
|
||||
[StructLayout(LayoutKind.Auto)]
|
||||
public readonly record struct InputSliceDevice(InputDevice Device, bool Active, BatteryReading? Battery);
|
||||
@@ -0,0 +1,205 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
using FrameLedger.Domain.Input;
|
||||
|
||||
namespace FrameLedger.Application.Input;
|
||||
|
||||
/// <summary>
|
||||
/// One session's slices added up into one <see cref="InputReading"/> per tick (<c>03_METRICS</c> §Input). The reader
|
||||
/// adds a slice about ten times a second on its own thread; the telemetry poller takes the sum once a second on its.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// <b>Only time the game was in front is classified.</b> A slice in which another program's window was in front counts
|
||||
/// for nothing but <see cref="InputReading.SpanMs"/>: typing in a browser beside the game is not the game played with
|
||||
/// the keyboard. A slice of a paused session is not observed either (a pause is a gap, <c>03_METRICS</c>).
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <b>A controller that is there when the session starts has not connected.</b> Connections and disconnections are
|
||||
/// counted from the second slice on, by comparing each slice's controllers with those of the slice before - paused or
|
||||
/// not, in front or not: a pad that drops out while the player is in another window still dropped out.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public sealed class InputTickAccumulator
|
||||
{
|
||||
private readonly Lock _gate = new();
|
||||
private readonly Dictionary<int, Entry> _devices = [];
|
||||
private HashSet<int> _connected = [];
|
||||
private bool _started;
|
||||
private InputHealth? _healthAtStart;
|
||||
private InputHealth _health = new();
|
||||
private int _spanMs;
|
||||
private int _observedMs;
|
||||
private int _foregroundMs;
|
||||
private int _controllerMs;
|
||||
private int _keyboardMouseMs;
|
||||
private int _bothMs;
|
||||
private int _idleMs;
|
||||
private bool _virtualPad;
|
||||
private bool _any;
|
||||
|
||||
/// <summary>Adds one slice.</summary>
|
||||
/// <param name="slice">What the reader saw.</param>
|
||||
/// <param name="inFront">Whether the process in front is one of the session's.</param>
|
||||
/// <param name="paused">Whether the session is paused.</param>
|
||||
public void Add(InputSlice slice, bool inFront, bool paused)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(slice);
|
||||
int elapsed = Math.Max(0, slice.ElapsedMs);
|
||||
lock (_gate)
|
||||
{
|
||||
_any = true;
|
||||
_healthAtStart ??= slice.Health;
|
||||
_health = slice.Health;
|
||||
_spanMs += elapsed;
|
||||
_virtualPad |= slice.VirtualPad;
|
||||
bool counted = inFront && !paused;
|
||||
bool controller = Track(slice.Devices, counted ? elapsed : 0);
|
||||
if (paused)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
_observedMs += elapsed;
|
||||
if (!inFront)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
_foregroundMs += elapsed;
|
||||
switch (controller, slice.KeyboardMouseActive)
|
||||
{
|
||||
case (true, true):
|
||||
_bothMs += elapsed;
|
||||
break;
|
||||
case (true, false):
|
||||
_controllerMs += elapsed;
|
||||
break;
|
||||
case (false, true):
|
||||
_keyboardMouseMs += elapsed;
|
||||
break;
|
||||
default:
|
||||
_idleMs += elapsed;
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>The sum since the last take, or null when no slice was added since then.</summary>
|
||||
public InputReading? Take()
|
||||
{
|
||||
lock (_gate)
|
||||
{
|
||||
if (!_any)
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
var devices = new List<InputDeviceReading>(_devices.Count);
|
||||
var table = new List<InputDevice>(_devices.Count);
|
||||
foreach ((int id, Entry entry) in _devices.OrderBy(static p => p.Key))
|
||||
{
|
||||
devices.Add(new InputDeviceReading(id, _connected.Contains(id), entry.ActiveMs, entry.Battery, entry.Connects, entry.Disconnects));
|
||||
table.Add(entry.Device);
|
||||
}
|
||||
|
||||
var reading = new InputReading
|
||||
{
|
||||
SpanMs = _spanMs,
|
||||
ObservedMs = _observedMs,
|
||||
ForegroundMs = _foregroundMs,
|
||||
ControllerMs = _controllerMs,
|
||||
KeyboardMouseMs = _keyboardMouseMs,
|
||||
BothMs = _bothMs,
|
||||
IdleMs = _idleMs,
|
||||
VirtualPad = _virtualPad,
|
||||
Devices = devices,
|
||||
Table = table,
|
||||
Health = _health.Since(_healthAtStart ?? _health),
|
||||
};
|
||||
|
||||
// The next tick starts with the controllers still connected and nothing counted for them yet.
|
||||
foreach (int id in _devices.Keys.Where(id => !_connected.Contains(id)).ToArray())
|
||||
{
|
||||
_devices.Remove(id);
|
||||
}
|
||||
|
||||
foreach (Entry entry in _devices.Values)
|
||||
{
|
||||
entry.Reset();
|
||||
}
|
||||
|
||||
_spanMs = _observedMs = _foregroundMs = _controllerMs = _keyboardMouseMs = _bothMs = _idleMs = 0;
|
||||
_virtualPad = false;
|
||||
_any = false;
|
||||
return reading;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>Notes each controller of the slice and what changed since the slice before; returns whether any was in use.</summary>
|
||||
private bool Track(IReadOnlyList<InputSliceDevice> devices, int countedMs)
|
||||
{
|
||||
var now = new HashSet<int>(devices.Count);
|
||||
bool anyActive = false;
|
||||
foreach (InputSliceDevice device in devices)
|
||||
{
|
||||
int id = device.Device.Id;
|
||||
if (!now.Add(id))
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
if (!_devices.TryGetValue(id, out Entry? entry))
|
||||
{
|
||||
entry = new Entry(device.Device);
|
||||
_devices[id] = entry;
|
||||
}
|
||||
|
||||
entry.Device = device.Device;
|
||||
entry.Battery = device.Battery ?? entry.Battery;
|
||||
if (_started && !_connected.Contains(id))
|
||||
{
|
||||
entry.Connects++;
|
||||
}
|
||||
|
||||
if (device.Active)
|
||||
{
|
||||
anyActive = true;
|
||||
entry.ActiveMs += countedMs;
|
||||
}
|
||||
}
|
||||
|
||||
foreach (int gone in _connected)
|
||||
{
|
||||
if (!now.Contains(gone) && _devices.TryGetValue(gone, out Entry? entry))
|
||||
{
|
||||
entry.Disconnects++;
|
||||
}
|
||||
}
|
||||
|
||||
_connected = now;
|
||||
_started = true;
|
||||
return anyActive;
|
||||
}
|
||||
|
||||
private sealed class Entry(InputDevice device)
|
||||
{
|
||||
public InputDevice Device { get; set; } = device;
|
||||
|
||||
public int ActiveMs { get; set; }
|
||||
|
||||
public BatteryReading? Battery { get; set; }
|
||||
|
||||
public int Connects { get; set; }
|
||||
|
||||
public int Disconnects { get; set; }
|
||||
|
||||
public void Reset()
|
||||
{
|
||||
ActiveMs = 0;
|
||||
Connects = 0;
|
||||
Disconnects = 0;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,24 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
using System.Runtime.InteropServices;
|
||||
using FrameLedger.Domain.Input;
|
||||
|
||||
namespace FrameLedger.Application.Input;
|
||||
|
||||
/// <summary>
|
||||
/// A game controller as Windows' raw input describes it, reduced to what the reader keeps: its two USB ids, whether
|
||||
/// Windows presents it through XInput, and how it is connected. The name these were read from is not here - it can
|
||||
/// carry an address - and nothing else of the device is asked for.
|
||||
/// </summary>
|
||||
/// <param name="VendorId">The USB vendor id.</param>
|
||||
/// <param name="ProductId">The USB product id.</param>
|
||||
/// <param name="XInputClass">Whether Windows presents the device through XInput (<see cref="RawDeviceName.IsXInputClass"/>).</param>
|
||||
/// <param name="Connection">How it is connected (<see cref="RawDeviceName.ConnectionOf"/>).</param>
|
||||
[StructLayout(LayoutKind.Auto)]
|
||||
public readonly record struct RawController(int VendorId, int ProductId, bool XInputClass, ControllerConnection Connection)
|
||||
{
|
||||
public bool IsVirtual => ControllerCatalog.IsVirtual(VendorId, ProductId);
|
||||
|
||||
public bool IsDualSense => !XInputClass && ControllerCatalog.IsDualSense(VendorId, ProductId);
|
||||
}
|
||||
@@ -0,0 +1,13 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
using System.Runtime.InteropServices;
|
||||
|
||||
namespace FrameLedger.Application.Input;
|
||||
|
||||
/// <summary>What XInput says of one of its pads beside its state: whether it is wireless, and its battery in XInput's own words.</summary>
|
||||
/// <param name="Wireless"><c>XINPUT_CAPS_WIRELESS</c>.</param>
|
||||
/// <param name="BatteryType"><c>XINPUT_BATTERY_INFORMATION.BatteryType</c>; 0 (disconnected) when XInput did not answer.</param>
|
||||
/// <param name="BatteryLevel"><c>XINPUT_BATTERY_INFORMATION.BatteryLevel</c>.</param>
|
||||
[StructLayout(LayoutKind.Auto)]
|
||||
public readonly record struct XInputDetails(bool Wireless, int BatteryType, int BatteryLevel);
|
||||
@@ -0,0 +1,22 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
using System.Runtime.InteropServices;
|
||||
|
||||
namespace FrameLedger.Application.Input;
|
||||
|
||||
/// <summary>
|
||||
/// One of XInput's pads at one read: <c>XINPUT_STATE</c> as it came. The reader asks one thing of it - is this a pad
|
||||
/// in use (<c>Domain.Input.XInputPad.IsActive</c>) - and whether its packet number moved; neither it nor anything
|
||||
/// derived from a single button or axis is kept.
|
||||
/// </summary>
|
||||
/// <param name="Packet"><c>dwPacketNumber</c>: it moves whenever anything on the pad changed.</param>
|
||||
/// <param name="Buttons"><c>wButtons</c>.</param>
|
||||
/// <param name="LeftTrigger"><c>bLeftTrigger</c>, 0-255.</param>
|
||||
/// <param name="RightTrigger"><c>bRightTrigger</c>, 0-255.</param>
|
||||
/// <param name="ThumbLx"><c>sThumbLX</c>.</param>
|
||||
/// <param name="ThumbLy"><c>sThumbLY</c>.</param>
|
||||
/// <param name="ThumbRx"><c>sThumbRX</c>.</param>
|
||||
/// <param name="ThumbRy"><c>sThumbRY</c>.</param>
|
||||
[StructLayout(LayoutKind.Auto)]
|
||||
public readonly record struct XInputReading(uint Packet, int Buttons, int LeftTrigger, int RightTrigger, int ThumbLx, int ThumbLy, int ThumbRx, int ThumbRy);
|
||||
@@ -128,6 +128,19 @@ public sealed record GameRow
|
||||
/// </summary>
|
||||
public AntiCheatExceptionState AcException { get; init; } = AntiCheatExceptionState.None;
|
||||
|
||||
/// <summary>
|
||||
/// What the store's own file on the disk says of controller support (schema 0024, D163): <c>full</c>, <c>partial</c>,
|
||||
/// or <c>none</c> for a game the store knows and lists no support for. Null when no store file describes the game or
|
||||
/// none was read yet. It is the store's word, one of three pieces of evidence - never a verdict of FrameLedger's.
|
||||
/// </summary>
|
||||
public string? ControllerSupport { get; init; }
|
||||
|
||||
/// <summary>The file <see cref="ControllerSupport"/> was read from: <c>steam-appinfo</c> (schema 0024).</summary>
|
||||
public string? ControllerSupportSource { get; init; }
|
||||
|
||||
/// <summary>When <see cref="ControllerSupport"/> was read (schema 0024).</summary>
|
||||
public DateTimeOffset? ControllerSupportAt { get; init; }
|
||||
|
||||
public bool InLibrary => RemovedAt is null;
|
||||
|
||||
/// <summary>
|
||||
|
||||
@@ -88,6 +88,14 @@ public interface ISessionRepository
|
||||
/// </summary>
|
||||
ValueTask<IReadOnlyList<SensorBlob>> FindAdvancedSensorsAsync(long sessionId, CancellationToken ct = default);
|
||||
|
||||
/// <summary>
|
||||
/// The session's input series (schema 0024, <c>03_METRICS</c> §Input), still encoded, with <c>t_ms</c> first: what
|
||||
/// each tick was mostly played with, and each controller's part and battery. For a session that stored none that
|
||||
/// is <c>t_ms</c> alone, or nothing. They are not among <see cref="FindSensorsAsync"/>'s for the reason the advanced
|
||||
/// ones are not: NaN marks a tick with nothing to say, and their values are not a sensor's.
|
||||
/// </summary>
|
||||
ValueTask<IReadOnlyList<SensorBlob>> FindInputSensorsAsync(long sessionId, CancellationToken ct = default);
|
||||
|
||||
/// <summary>
|
||||
/// The session's row of <c>session_advanced</c> with the machine profile it points to, or null: it was recorded
|
||||
/// with Advanced metrics off (or before they existed).
|
||||
|
||||
@@ -401,4 +401,38 @@ public sealed record SessionRow
|
||||
|
||||
/// <summary>Application frames per joule of the card's power — FPS per watt; never over displayed frames (rule 6).</summary>
|
||||
public double? AppFramesPerJoule { get; init; }
|
||||
|
||||
// --- Schema 0024 (beta.50, D155-D163): what the session was played with (03_METRICS §Input), both tiers - read by the
|
||||
// Agent from outside the game. Null on a row written before it, with the option off, and before the terms that
|
||||
// describe the reading were accepted.
|
||||
|
||||
/// <summary>The time the input reader ran and the session was not paused, in milliseconds.</summary>
|
||||
public long? InputObservedMs { get; init; }
|
||||
|
||||
/// <summary>Of <see cref="InputObservedMs"/>, the time a window of the game was in front: what every share is a share of.</summary>
|
||||
public long? InputForegroundMs { get; init; }
|
||||
|
||||
/// <summary>The time in front a controller was in use and the keyboard and mouse were not.</summary>
|
||||
public long? InputControllerMs { get; init; }
|
||||
|
||||
/// <summary>The time in front the keyboard or mouse was in use and no controller was. One class: only the time of the last input is read (D158).</summary>
|
||||
public long? InputKeyboardMouseMs { get; init; }
|
||||
|
||||
public long? InputBothMs { get; init; }
|
||||
|
||||
/// <summary>The time in front with no input at all.</summary>
|
||||
public long? InputIdleMs { get; init; }
|
||||
|
||||
/// <summary>How many times the player went from a controller to the keyboard and mouse or back.</summary>
|
||||
public int? InputMethodSwitches { get; init; }
|
||||
|
||||
/// <summary>The sources that answered: <c>rawinput</c>, <c>xinput</c>, <c>lastinput</c>, joined by <c>+</c>.</summary>
|
||||
public string? InputSource { get; init; }
|
||||
|
||||
/// <summary>The session's controllers, their batteries and makers, and what the reader's sources did, as <c>InputDevicesRecord</c>'s JSON.</summary>
|
||||
public string? InputDevicesJson { get; init; }
|
||||
|
||||
/// <summary>The share of the time in front spent in one class, 0-100; null when nothing was read or the game was never in front.</summary>
|
||||
public double? InputSharePercent(long? classMs) =>
|
||||
InputForegroundMs is > 0 and var front && classMs is { } ms ? 100d * ms / front : null;
|
||||
}
|
||||
@@ -33,7 +33,12 @@ public static class AdvancedSessionBuilder
|
||||
/// </summary>
|
||||
public const int MaxSeries = 256;
|
||||
|
||||
public static (IReadOnlyList<SensorBlob> Blobs, AdvancedSessionRow? Row) Build(IReadOnlyList<TelemetrySample> sensors, AdvancedSessionData? data, ISeriesCodec codec)
|
||||
/// <summary>The session's advanced series as blobs, and its <c>session_advanced</c> row — nothing when there is neither a series nor data.</summary>
|
||||
/// <param name="sensors">The session's samples, in order.</param>
|
||||
/// <param name="data">What the session knew of the machine and itself, or null when the option was off.</param>
|
||||
/// <param name="codec">How a series is encoded.</param>
|
||||
/// <param name="hz">The rate the samples had (<see cref="SessionFinalizer.SampleRate"/>): stored with each series as the fallback for a reader with no <c>t_ms</c>.</param>
|
||||
public static (IReadOnlyList<SensorBlob> Blobs, AdvancedSessionRow? Row) Build(IReadOnlyList<TelemetrySample> sensors, AdvancedSessionData? data, ISeriesCodec codec, double hz = 1)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(sensors);
|
||||
ArgumentNullException.ThrowIfNull(codec);
|
||||
@@ -48,7 +53,7 @@ public static class AdvancedSessionBuilder
|
||||
var stats = new Dictionary<string, SensorSeriesStats>(StringComparer.Ordinal);
|
||||
for (int s = 0; s < names.Count; s++)
|
||||
{
|
||||
blobs.Add(new SensorBlob { Series = names[s], Hz = 1, Codec = codec.Tag, Data = codec.EncodeSparseFloat32(columns[s]) });
|
||||
blobs.Add(new SensorBlob { Series = names[s], Hz = hz, Codec = codec.Tag, Data = codec.EncodeSparseFloat32(columns[s]) });
|
||||
SeriesAggregates aggregates = SeriesAggregates.Of(columns[s].Select(static v => float.IsNaN(v) ? (double?)null : v));
|
||||
if (aggregates.Count > 0)
|
||||
{
|
||||
|
||||
@@ -0,0 +1,25 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
using FrameLedger.Application.Input;
|
||||
|
||||
namespace FrameLedger.Application.Recording;
|
||||
|
||||
/// <summary>A controller's battery over the session, in <see cref="InputDeviceRecord"/>.</summary>
|
||||
public sealed record InputBatteryRecord
|
||||
{
|
||||
/// <summary><c>levels</c> (0 empty to 3 full), <c>percent</c>, or <c>none</c> for a wired pad.</summary>
|
||||
public string Scale { get; init; } = InputNames.None;
|
||||
|
||||
/// <summary>Every state it was read in, the longest first.</summary>
|
||||
public IReadOnlyList<InputBatteryStateRecord> States { get; init; } = [];
|
||||
|
||||
/// <summary>The first level read, in <see cref="Scale"/>; null when no reading had a level.</summary>
|
||||
public int? First { get; init; }
|
||||
|
||||
/// <summary>The last level read.</summary>
|
||||
public int? Last { get; init; }
|
||||
|
||||
/// <summary>How fast it ran down, in per cent an hour, when that could be worked out (<c>03_METRICS</c> §Input).</summary>
|
||||
public double? DrainPercentPerHour { get; init; }
|
||||
}
|
||||
@@ -0,0 +1,10 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
namespace FrameLedger.Application.Recording;
|
||||
|
||||
/// <summary>One battery state and the time it was read, in <see cref="InputBatteryRecord"/>.</summary>
|
||||
/// <param name="State">What the battery was doing, in <c>InputNames</c>' words.</param>
|
||||
/// <param name="Level">The level, in the battery's scale.</param>
|
||||
/// <param name="Ms">The time it was read in this state.</param>
|
||||
public sealed record InputBatteryStateRecord(string State, int Level, long Ms);
|
||||
@@ -0,0 +1,42 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
using FrameLedger.Application.Input;
|
||||
|
||||
namespace FrameLedger.Application.Recording;
|
||||
|
||||
/// <summary>One controller of a session, in <see cref="InputDevicesRecord"/>.</summary>
|
||||
public sealed record InputDeviceRecord
|
||||
{
|
||||
/// <summary>The controller's number in the session, from 1: what its series are named by (<c>input.dev.N.active</c>).</summary>
|
||||
public int Index { get; init; }
|
||||
|
||||
public string Family { get; init; } = InputNames.Other;
|
||||
|
||||
public int VendorId { get; init; }
|
||||
|
||||
public int ProductId { get; init; }
|
||||
|
||||
public string? Model { get; init; }
|
||||
|
||||
public string Connection { get; init; } = InputNames.Unknown;
|
||||
|
||||
public int? XInputSlot { get; init; }
|
||||
|
||||
/// <summary>The pad is one a program presents and no controller a player holds was found behind it.</summary>
|
||||
public bool Virtual { get; init; }
|
||||
|
||||
/// <summary>A second pad moved exactly as this one did and was folded into it: Steam Input, or another remapper, was presenting this controller to games as an Xbox pad.</summary>
|
||||
public bool Remapped { get; init; }
|
||||
|
||||
public long ConnectedMs { get; init; }
|
||||
|
||||
/// <summary>The time it was in use while the game was in front.</summary>
|
||||
public long ActiveMs { get; init; }
|
||||
|
||||
public int Connects { get; init; }
|
||||
|
||||
public int Disconnects { get; init; }
|
||||
|
||||
public InputBatteryRecord? Battery { get; init; }
|
||||
}
|
||||
@@ -0,0 +1,56 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
using System.Text.Json;
|
||||
using FrameLedger.Application.Input;
|
||||
|
||||
namespace FrameLedger.Application.Recording;
|
||||
|
||||
/// <summary>
|
||||
/// <c>sessions.input_devices</c> (schema 0024, owner decisions of 2026-11-14): the controllers of a session as JSON -
|
||||
/// what each was, how long it was connected and in use, how often it connected and dropped, its battery - with each
|
||||
/// maker's share, how often the maker changed, and what the reader's sources did.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// The words for a family, a connection and a battery state are <see cref="InputNames"/>'s, lower case, and are never
|
||||
/// renamed: a ledger keeps them. A model is a product name or absent. No serial number, address or path is here, and
|
||||
/// <c>InputSessionBuilderTests</c> hold that no key of the JSON could carry one.
|
||||
/// </remarks>
|
||||
public sealed record InputDevicesRecord
|
||||
{
|
||||
/// <summary>The format's version; 1.</summary>
|
||||
public int V { get; init; } = 1;
|
||||
|
||||
public IReadOnlyList<InputDeviceRecord> Devices { get; init; } = [];
|
||||
|
||||
/// <summary>Each maker's part of the time controllers were in use, the largest first.</summary>
|
||||
public IReadOnlyList<InputFamilyRecord> Families { get; init; } = [];
|
||||
|
||||
/// <summary>How many times the maker of the controller in use changed.</summary>
|
||||
public int FamilySwitches { get; init; }
|
||||
|
||||
/// <summary>Whether a pad a program presents - Steam's virtual gamepad - was seen.</summary>
|
||||
public bool VirtualPad { get; init; }
|
||||
|
||||
public InputHealth Health { get; init; } = new();
|
||||
|
||||
public static string ToJson(InputDevicesRecord record) => JsonSerializer.Serialize(record, RecordingJsonContext.Default.InputDevicesRecord);
|
||||
|
||||
/// <summary>The column's text back, or null for a null, empty or unparsable column.</summary>
|
||||
public static InputDevicesRecord? Parse(string? json)
|
||||
{
|
||||
if (string.IsNullOrWhiteSpace(json))
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
try
|
||||
{
|
||||
return JsonSerializer.Deserialize(json, RecordingJsonContext.Default.InputDevicesRecord);
|
||||
}
|
||||
catch (JsonException)
|
||||
{
|
||||
return null;
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,10 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
namespace FrameLedger.Application.Recording;
|
||||
|
||||
/// <summary>One maker's part of the time controllers were in use, in <see cref="InputDevicesRecord"/>.</summary>
|
||||
/// <param name="Family">The maker, in <c>InputNames</c>' words.</param>
|
||||
/// <param name="ActiveMs">The time its controllers were in use while the game was in front.</param>
|
||||
/// <param name="Share">That time over the same time of every maker, 0 to 1.</param>
|
||||
public sealed record InputFamilyRecord(string Family, long ActiveMs, double Share);
|
||||
@@ -0,0 +1,316 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
using System.Globalization;
|
||||
using FrameLedger.Application.Input;
|
||||
using FrameLedger.Application.Persistence;
|
||||
using FrameLedger.Application.Telemetry;
|
||||
using FrameLedger.Domain.Input;
|
||||
|
||||
namespace FrameLedger.Application.Recording;
|
||||
|
||||
/// <summary>
|
||||
/// What a session stores of its input readings (<c>03_METRICS</c> §Input, owner decisions of 2026-11-14): the totals,
|
||||
/// the controllers with their batteries and makers, and the series a timeline is drawn from - all from the samples, so
|
||||
/// a session recovered from its <c>.partial</c> file has them as a finished one does.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// <b>Nothing in, nothing out.</b> A session none of whose samples carries a reading - the option was off, or the
|
||||
/// terms that say what is read were not accepted yet - stores no series and no summary, and is byte for byte what it
|
||||
/// was before this existed.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <b>One pad seen twice is one controller.</b> Windows shows a controller that Steam Input stands in front of twice:
|
||||
/// the one the player holds, and an Xbox pad Steam presents for it. An XInput pad that was in use at the same moments
|
||||
/// as another controller is folded into it (<see cref="VirtualPad"/>) - into a controller that is not XInput's at any
|
||||
/// time, into another of XInput's pads only in a session where Steam's virtual gamepad was seen.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public static class InputSessionBuilder
|
||||
{
|
||||
/// <summary>The most controllers one session stores series for; more are counted in the totals and not listed.</summary>
|
||||
public const int MaxDevices = 8;
|
||||
|
||||
public const string ClassSeries = "input.class";
|
||||
|
||||
/// <summary>What every series of this builder starts with: how a reader tells them from the sensors' and the advanced ones.</summary>
|
||||
public const string SeriesPrefix = "input.";
|
||||
|
||||
public static string ActiveSeries(int index) => string.Create(CultureInfo.InvariantCulture, $"input.dev.{index}.active");
|
||||
|
||||
public static string BatterySeries(int index) => string.Create(CultureInfo.InvariantCulture, $"input.dev.{index}.battery");
|
||||
|
||||
/// <summary>The session's input series as blobs and its summary - nothing when no sample carries a reading.</summary>
|
||||
/// <param name="sensors">The session's samples, in order.</param>
|
||||
/// <param name="codec">How a series is encoded.</param>
|
||||
/// <param name="hz">The rate the samples had, stored with each series as the fallback for a reader with no <c>t_ms</c>.</param>
|
||||
public static (IReadOnlyList<SensorBlob> Blobs, InputSessionSummary? Summary) Build(IReadOnlyList<TelemetrySample> sensors, ISeriesCodec codec, double hz = 1)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(sensors);
|
||||
ArgumentNullException.ThrowIfNull(codec);
|
||||
if (!sensors.Any(static s => s.Input is not null))
|
||||
{
|
||||
return ([], null);
|
||||
}
|
||||
|
||||
List<Track> tracks = Tracks(sensors);
|
||||
bool virtualPad = sensors.Any(static s => s.Input?.VirtualPad == true);
|
||||
Fold(tracks, virtualPad);
|
||||
Track[] kept = [.. tracks.Where(static t => !t.Folded)];
|
||||
|
||||
var blobs = new List<SensorBlob> { Blob(ClassSeries, ClassColumn(sensors), codec, hz) };
|
||||
var devices = new List<InputDeviceRecord>(kept.Length);
|
||||
for (int d = 0; d < kept.Length; d++)
|
||||
{
|
||||
devices.Add(kept[d].ToRecord(d + 1));
|
||||
if (d < MaxDevices)
|
||||
{
|
||||
blobs.Add(Blob(ActiveSeries(d + 1), kept[d].ActiveColumn(sensors), codec, hz));
|
||||
if (kept[d].Battery.Any(static b => b is { Scale: not BatteryScale.None }))
|
||||
{
|
||||
blobs.Add(Blob(BatterySeries(d + 1), kept[d].BatteryColumn(), codec, hz));
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
InputHealth health = sensors.Last(static s => s.Input is not null).Input!.Health;
|
||||
var record = new InputDevicesRecord
|
||||
{
|
||||
Devices = devices,
|
||||
Families = Families(kept),
|
||||
FamilySwitches = InputSwitches.Count(FamilyTicks(kept, sensors.Count)),
|
||||
VirtualPad = virtualPad,
|
||||
Health = health,
|
||||
};
|
||||
|
||||
return (blobs, new InputSessionSummary
|
||||
{
|
||||
ObservedMs = sensors.Sum(static s => (long)(s.Input?.ObservedMs ?? 0)),
|
||||
ForegroundMs = sensors.Sum(static s => (long)(s.Input?.ForegroundMs ?? 0)),
|
||||
ControllerMs = sensors.Sum(static s => (long)(s.Input?.ControllerMs ?? 0)),
|
||||
KeyboardMouseMs = sensors.Sum(static s => (long)(s.Input?.KeyboardMouseMs ?? 0)),
|
||||
BothMs = sensors.Sum(static s => (long)(s.Input?.BothMs ?? 0)),
|
||||
IdleMs = sensors.Sum(static s => (long)(s.Input?.IdleMs ?? 0)),
|
||||
MethodSwitches = InputSwitches.Count(sensors.Select(static s => s.Input is { } r
|
||||
? InputSwitches.Exclusive(r.ControllerMs, r.KeyboardMouseMs, r.BothMs)
|
||||
: null)),
|
||||
Source = health.Sources(),
|
||||
DevicesJson = InputDevicesRecord.ToJson(record),
|
||||
});
|
||||
}
|
||||
|
||||
private static SensorBlob Blob(string series, float[] column, ISeriesCodec codec, double hz) =>
|
||||
new() { Series = series, Hz = hz, Codec = codec.Tag, Data = codec.EncodeSparseFloat32(column) };
|
||||
|
||||
/// <summary>What each tick was mostly played with, as <see cref="InputClass"/>'s number; NaN for a tick with no reading or with the game not in front.</summary>
|
||||
private static float[] ClassColumn(IReadOnlyList<TelemetrySample> sensors)
|
||||
{
|
||||
float[] column = new float[sensors.Count];
|
||||
for (int i = 0; i < sensors.Count; i++)
|
||||
{
|
||||
column[i] = sensors[i].Input is { } r && InputSwitches.Dominant(r.ControllerMs, r.KeyboardMouseMs, r.BothMs, r.IdleMs) is { } dominant
|
||||
? (int)dominant
|
||||
: float.NaN;
|
||||
}
|
||||
|
||||
return column;
|
||||
}
|
||||
|
||||
/// <summary>One track per controller the samples name, in the order they first appear.</summary>
|
||||
private static List<Track> Tracks(IReadOnlyList<TelemetrySample> sensors)
|
||||
{
|
||||
var tracks = new List<Track>();
|
||||
var byId = new Dictionary<int, Track>();
|
||||
for (int i = 0; i < sensors.Count; i++)
|
||||
{
|
||||
if (sensors[i].Input is not { } reading)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
foreach (InputDevice device in reading.Table)
|
||||
{
|
||||
if (!byId.TryGetValue(device.Id, out Track? track))
|
||||
{
|
||||
track = new Track(device, sensors.Count);
|
||||
byId[device.Id] = track;
|
||||
tracks.Add(track);
|
||||
}
|
||||
|
||||
track.Device = device;
|
||||
}
|
||||
|
||||
foreach (InputDeviceReading d in reading.Devices)
|
||||
{
|
||||
if (byId.TryGetValue(d.DeviceId, out Track? track))
|
||||
{
|
||||
track.Add(i, d, reading.SpanMs);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return tracks;
|
||||
}
|
||||
|
||||
/// <summary>Folds each of XInput's pads that moved with another controller into that controller.</summary>
|
||||
private static void Fold(List<Track> tracks, bool virtualPad)
|
||||
{
|
||||
foreach (Track pad in tracks.Where(static t => t.Device.XInputSlot is not null))
|
||||
{
|
||||
// A controller that is not XInput's first: it is the one the player holds. Then, only with Steam's pad seen,
|
||||
// an XInput pad of a lower number - which of the two Steam presents cannot be told, and it does not matter.
|
||||
Track? into = tracks.FirstOrDefault(t => !t.Folded && t.Device.XInputSlot is null && VirtualPad.IsSamePad(pad.ActiveMs, t.ActiveMs));
|
||||
if (into is null && virtualPad)
|
||||
{
|
||||
into = tracks.FirstOrDefault(t => !t.Folded && !ReferenceEquals(t, pad) && t.Device.XInputSlot < pad.Device.XInputSlot
|
||||
&& VirtualPad.IsSamePad(pad.ActiveMs, t.ActiveMs));
|
||||
}
|
||||
|
||||
if (into is not null)
|
||||
{
|
||||
pad.Folded = true;
|
||||
into.Remapped = true;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private static List<InputFamilyRecord> Families(Track[] kept)
|
||||
{
|
||||
long total = kept.Sum(static t => t.TotalActiveMs);
|
||||
return [.. kept
|
||||
.GroupBy(static t => t.Device.Family)
|
||||
.Select(g => (Family: g.Key, Ms: g.Sum(static t => t.TotalActiveMs)))
|
||||
.Where(static f => f.Ms > 0)
|
||||
.OrderByDescending(static f => f.Ms)
|
||||
.ThenBy(static f => f.Family)
|
||||
.Select(f => new InputFamilyRecord(InputNames.Of(f.Family), f.Ms, Math.Round((double)f.Ms / total, 4)))];
|
||||
}
|
||||
|
||||
/// <summary>The one maker whose controller was in use on each tick, or null where none or more than one was.</summary>
|
||||
private static IEnumerable<ControllerFamily?> FamilyTicks(Track[] kept, int ticks)
|
||||
{
|
||||
for (int i = 0; i < ticks; i++)
|
||||
{
|
||||
ControllerFamily? only = null;
|
||||
bool several = false;
|
||||
foreach (Track track in kept)
|
||||
{
|
||||
if (track.ActiveMs[i] <= 0)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
several |= only is { } seen && seen != track.Device.Family;
|
||||
only = track.Device.Family;
|
||||
}
|
||||
|
||||
yield return several ? null : only;
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>One controller across the session's ticks.</summary>
|
||||
private sealed class Track(InputDevice device, int ticks)
|
||||
{
|
||||
private readonly bool[] _connected = new bool[ticks];
|
||||
private readonly BatteryTally _tally = new();
|
||||
private long _connectedMs;
|
||||
private int _connects;
|
||||
private int _disconnects;
|
||||
|
||||
public InputDevice Device { get; set; } = device;
|
||||
|
||||
public int[] ActiveMs { get; } = new int[ticks];
|
||||
|
||||
public BatteryReading?[] Battery { get; } = new BatteryReading?[ticks];
|
||||
|
||||
public long TotalActiveMs => ActiveMs.Sum(static ms => (long)ms);
|
||||
|
||||
/// <summary>Another controller's, and not listed.</summary>
|
||||
public bool Folded { get; set; }
|
||||
|
||||
/// <summary>A pad that moved with it was folded into it.</summary>
|
||||
public bool Remapped { get; set; }
|
||||
|
||||
public void Add(int tick, InputDeviceReading reading, int spanMs)
|
||||
{
|
||||
ActiveMs[tick] = reading.ActiveMs;
|
||||
_connected[tick] = reading.Connected;
|
||||
_connects += reading.Connects;
|
||||
_disconnects += reading.Disconnects;
|
||||
if (!reading.Connected)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
_connectedMs += spanMs;
|
||||
if (reading.Battery is { } battery)
|
||||
{
|
||||
Battery[tick] = battery;
|
||||
_tally.Add(battery, spanMs);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>The part of each tick's time in front that the controller was in use, 0 to 1; NaN where it was not connected.</summary>
|
||||
public float[] ActiveColumn(IReadOnlyList<TelemetrySample> sensors)
|
||||
{
|
||||
float[] column = new float[ActiveMs.Length];
|
||||
for (int i = 0; i < column.Length; i++)
|
||||
{
|
||||
int front = sensors[i].Input?.ForegroundMs ?? 0;
|
||||
column[i] = !_connected[i] ? float.NaN : front <= 0 ? 0f : Math.Clamp((float)ActiveMs[i] / front, 0f, 1f);
|
||||
}
|
||||
|
||||
return column;
|
||||
}
|
||||
|
||||
/// <summary>The battery's level on each tick, in its own scale; NaN where there was none.</summary>
|
||||
public float[] BatteryColumn()
|
||||
{
|
||||
float[] column = new float[Battery.Length];
|
||||
for (int i = 0; i < column.Length; i++)
|
||||
{
|
||||
column[i] = Battery[i] is { Scale: not BatteryScale.None } b ? b.Level : float.NaN;
|
||||
}
|
||||
|
||||
return column;
|
||||
}
|
||||
|
||||
public InputDeviceRecord ToRecord(int index) => new()
|
||||
{
|
||||
Index = index,
|
||||
Family = InputNames.Of(Device.Family),
|
||||
VendorId = Device.VendorId,
|
||||
ProductId = Device.ProductId,
|
||||
Model = Device.Model,
|
||||
Connection = InputNames.Of(Device.Connection),
|
||||
XInputSlot = Device.XInputSlot,
|
||||
Virtual = Device.IsVirtual,
|
||||
Remapped = Remapped,
|
||||
ConnectedMs = _connectedMs,
|
||||
ActiveMs = TotalActiveMs,
|
||||
Connects = _connects,
|
||||
Disconnects = _disconnects,
|
||||
Battery = BatteryRecord(),
|
||||
};
|
||||
|
||||
private InputBatteryRecord? BatteryRecord()
|
||||
{
|
||||
if (!_tally.Any)
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
BatterySummary summary = _tally.Summary();
|
||||
BatteryScale scale = summary.States.Select(static s => s.Scale).FirstOrDefault(static s => s != BatteryScale.None);
|
||||
return new InputBatteryRecord
|
||||
{
|
||||
Scale = InputNames.Of(scale),
|
||||
States = [.. summary.States.Select(static s => new InputBatteryStateRecord(InputNames.Of(s.State), s.Level, s.Ms))],
|
||||
First = summary.First is { Scale: not BatteryScale.None } first ? first.Level : null,
|
||||
Last = summary.Last is { Scale: not BatteryScale.None } last ? last.Level : null,
|
||||
DrainPercentPerHour = summary.DrainPercentPerHour,
|
||||
};
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,33 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
using FrameLedger.Application.Input;
|
||||
|
||||
namespace FrameLedger.Application.Recording;
|
||||
|
||||
/// <summary>What <see cref="InputSessionBuilder"/> makes of a session's input readings: the totals a session row stores, and the controllers as JSON.</summary>
|
||||
public sealed record InputSessionSummary
|
||||
{
|
||||
/// <summary>The time the reader ran and the session was not paused.</summary>
|
||||
public long ObservedMs { get; init; }
|
||||
|
||||
/// <summary>Of that, the time a window of the game was in front: what every share is a share of.</summary>
|
||||
public long ForegroundMs { get; init; }
|
||||
|
||||
public long ControllerMs { get; init; }
|
||||
|
||||
public long KeyboardMouseMs { get; init; }
|
||||
|
||||
public long BothMs { get; init; }
|
||||
|
||||
public long IdleMs { get; init; }
|
||||
|
||||
/// <summary>How many times the player went from a controller to the keyboard and mouse or back.</summary>
|
||||
public int MethodSwitches { get; init; }
|
||||
|
||||
/// <summary>The sources that answered (<see cref="InputHealth.Sources"/>).</summary>
|
||||
public string Source { get; init; } = string.Empty;
|
||||
|
||||
/// <summary><c>sessions.input_devices</c>.</summary>
|
||||
public string DevicesJson { get; init; } = string.Empty;
|
||||
}
|
||||
@@ -0,0 +1,62 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
using System.Diagnostics.CodeAnalysis;
|
||||
using FrameLedger.Application.Advanced;
|
||||
|
||||
namespace FrameLedger.Application.Recording;
|
||||
|
||||
/// <summary>
|
||||
/// What a hooked game published and no telemetry sample carries yet (owner decision D150): at most
|
||||
/// <see cref="Capacity"/> sets of readings, the older taken first.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// <b>Why not one.</b> A publication arrives about once a second and a sample exactly once a second, on two clocks,
|
||||
/// and the recorder looks at both every tenth of a second or so. Until 0.1.0-beta.49 it kept the newest set and
|
||||
/// overwrote it: when a publication landed just after a sample, a look could fall between the two - that sample went
|
||||
/// without, and at the next change of step the set that had waited was overwritten by its successor. In the owner's
|
||||
/// sessions that was one sample in five without a report for minutes on end (HANDOFF, item 46).
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <b>What two give.</b> A set that waited is carried by the next sample instead of being replaced, so with both sides
|
||||
/// on a second a session lacks a report at one sample at most - the first time the two fall out of step - and loses
|
||||
/// none after it. A reading then stands at the sample after the one it would have ridden: a second later, no more.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <b>What it does not give.</b> With the sensor interval above a second more sets arrive than samples: a third
|
||||
/// pushes the oldest out, and not every reading is stored - as before, and as the guide says.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public sealed class PendingInGameReadings
|
||||
{
|
||||
/// <summary>The most sets that wait: the one a sample is about to carry, and the one that arrived meanwhile.</summary>
|
||||
public const int Capacity = 2;
|
||||
|
||||
private readonly Queue<IReadOnlyList<AdvancedReading>> _waiting = new(Capacity);
|
||||
|
||||
/// <summary>How many sets wait.</summary>
|
||||
public int Count => _waiting.Count;
|
||||
|
||||
/// <summary>A publication's readings. A set with nothing in it does not wait: it would only stand in a real one's way.</summary>
|
||||
/// <param name="readings">The readings of one publication.</param>
|
||||
public void Offer(IReadOnlyList<AdvancedReading> readings)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(readings);
|
||||
if (readings.Count == 0)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
if (_waiting.Count == Capacity)
|
||||
{
|
||||
_ = _waiting.Dequeue();
|
||||
}
|
||||
|
||||
_waiting.Enqueue(readings);
|
||||
}
|
||||
|
||||
/// <summary>The oldest set that waits, which then waits no longer; false when none does.</summary>
|
||||
/// <param name="readings">The set, when there is one.</param>
|
||||
public bool TryTake([NotNullWhen(true)] out IReadOnlyList<AdvancedReading>? readings) => _waiting.TryDequeue(out readings);
|
||||
}
|
||||
@@ -14,6 +14,7 @@ namespace FrameLedger.Application.Recording;
|
||||
[JsonSerializable(typeof(FgMixRecord))]
|
||||
[JsonSerializable(typeof(DriverProfileRecord))]
|
||||
[JsonSerializable(typeof(Dictionary<string, SensorSeriesStats>))]
|
||||
[JsonSerializable(typeof(InputDevicesRecord))]
|
||||
public sealed partial class RecordingJsonContext : JsonSerializerContext
|
||||
{
|
||||
}
|
||||
@@ -59,7 +59,14 @@ public sealed class SessionFinalizer
|
||||
|
||||
// Advanced metrics (D102), both tiers: they are read by the Agent, not by a hook, so a session that was not
|
||||
// hooked has them all the same. Nothing when the option was off - no series, no row.
|
||||
(IReadOnlyList<SensorBlob> advancedBlobs, AdvancedSessionRow? advanced) = AdvancedSessionBuilder.Build(input.Sensors, input.Advanced, _codec);
|
||||
double hz = SampleRate(input.Sensors, row.QpcFrequency);
|
||||
(IReadOnlyList<SensorBlob> advancedBlobs, AdvancedSessionRow? advanced) = AdvancedSessionBuilder.Build(input.Sensors, input.Advanced, _codec, hz);
|
||||
|
||||
// What the session was played with (D155-D163), both tiers and for the same reason: the Agent reads it from outside
|
||||
// the game. From the samples alone, so a session recovered from its .partial file has it. Nothing when no sample
|
||||
// carries a reading - the option was off, or the terms that describe the reading were not accepted yet.
|
||||
(IReadOnlyList<SensorBlob> inputBlobs, InputSessionSummary? played) = InputSessionBuilder.Build(input.Sensors, _codec, hz);
|
||||
row = WithInput(row, played);
|
||||
if (input.Hooked is null)
|
||||
{
|
||||
// A Tier-2 row has no frames and every sensor the machine provided (2026-09-22): the same averages a
|
||||
@@ -67,7 +74,7 @@ public sealed class SessionFinalizer
|
||||
return new FinalizedSession
|
||||
{
|
||||
Row = SessionAggregator.WithSensorAggregates(row with { Tier = CaptureTier.NotHooked }, input.Sensors),
|
||||
Sensors = [.. EncodeSensors(input.Sensors, row.QpcEpoch, row.QpcFrequency), .. advancedBlobs],
|
||||
Sensors = [.. EncodeSensors(input.Sensors, row.QpcEpoch, row.QpcFrequency, hz), .. advancedBlobs, .. inputBlobs],
|
||||
Advanced = advanced,
|
||||
};
|
||||
}
|
||||
@@ -82,11 +89,48 @@ public sealed class SessionFinalizer
|
||||
{
|
||||
FirstPresentMs = FirstPresentMs(r.Dominant, row.QpcEpoch, row.QpcFrequency),
|
||||
},
|
||||
Sensors = [.. EncodeSensors(input.Sensors, row.QpcEpoch, row.QpcFrequency), .. advancedBlobs],
|
||||
Sensors = [.. EncodeSensors(input.Sensors, row.QpcEpoch, row.QpcFrequency, hz), .. advancedBlobs, .. inputBlobs],
|
||||
Advanced = advanced,
|
||||
};
|
||||
}
|
||||
|
||||
/// <summary>The row with what the session was played with (schema 0024); unchanged when nothing was read.</summary>
|
||||
private static SessionRow WithInput(SessionRow row, InputSessionSummary? played) => played is null
|
||||
? row
|
||||
: row with
|
||||
{
|
||||
InputObservedMs = played.ObservedMs,
|
||||
InputForegroundMs = played.ForegroundMs,
|
||||
InputControllerMs = played.ControllerMs,
|
||||
InputKeyboardMouseMs = played.KeyboardMouseMs,
|
||||
InputBothMs = played.BothMs,
|
||||
InputIdleMs = played.IdleMs,
|
||||
InputMethodSwitches = played.MethodSwitches,
|
||||
InputSource = played.Source,
|
||||
InputDevicesJson = played.DevicesJson,
|
||||
};
|
||||
|
||||
/// <summary>
|
||||
/// The rate the session's samples had, a second (owner decision D146): the gaps between the first and the last
|
||||
/// over the time between them, to a thousandth. 1 where there are fewer than two samples or no time between them.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// Measured, not the configured interval: it is then right for a session recovered from a <c>.partial</c> file,
|
||||
/// which never knew the setting, and for one whose poller could not keep its period. It is the FALLBACK for a
|
||||
/// reader: every series is stored beside <c>t_ms</c>, which carries each sample's own time.
|
||||
/// </remarks>
|
||||
public static double SampleRate(IReadOnlyList<TelemetrySample> sensors, long qpcFrequency)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(sensors);
|
||||
if (sensors.Count < 2 || qpcFrequency <= 0)
|
||||
{
|
||||
return 1;
|
||||
}
|
||||
|
||||
long span = sensors[^1].QpcTicks - sensors[0].QpcTicks;
|
||||
return span <= 0 ? 1 : Math.Round((sensors.Count - 1) * (double)qpcFrequency / span, 3);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// The discard rule, the owner, then step 5: one transaction, then the retention sweep.
|
||||
/// </summary>
|
||||
@@ -248,7 +292,7 @@ public sealed class SessionFinalizer
|
||||
}
|
||||
|
||||
/// <summary><c>t_ms</c> plus one series per field any sample carried, aligned to <c>t_ms</c>, −1 where a tick had no reading.</summary>
|
||||
private List<SensorBlob> EncodeSensors(IReadOnlyList<TelemetrySample> sensors, ulong qpcEpoch, long qpcFrequency)
|
||||
private List<SensorBlob> EncodeSensors(IReadOnlyList<TelemetrySample> sensors, ulong qpcEpoch, long qpcFrequency, double hz)
|
||||
{
|
||||
if (sensors.Count == 0)
|
||||
{
|
||||
@@ -257,34 +301,34 @@ public sealed class SessionFinalizer
|
||||
|
||||
var blobs = new List<SensorBlob>
|
||||
{
|
||||
Blob("t_ms", sensors, s => (float)((s.QpcTicks - (long)qpcEpoch) * 1000.0 / qpcFrequency)),
|
||||
Blob("t_ms", sensors, hz, s => (float)((s.QpcTicks - (long)qpcEpoch) * 1000.0 / qpcFrequency)),
|
||||
};
|
||||
// One list (SensorSeriesCatalog) for the blobs and for sensor_stats_json; the game process's memory joined it in
|
||||
// beta.12 (D43) — five series, MiB, both tiers.
|
||||
foreach ((string name, Func<TelemetrySample, double?> select) in SensorSeriesCatalog.All)
|
||||
{
|
||||
AddIfAny(blobs, name, sensors, select);
|
||||
AddIfAny(blobs, name, sensors, hz, select);
|
||||
}
|
||||
|
||||
return blobs;
|
||||
}
|
||||
|
||||
private void AddIfAny(List<SensorBlob> into, string series, IReadOnlyList<TelemetrySample> sensors, Func<TelemetrySample, double?> field)
|
||||
private void AddIfAny(List<SensorBlob> into, string series, IReadOnlyList<TelemetrySample> sensors, double hz, Func<TelemetrySample, double?> field)
|
||||
{
|
||||
if (sensors.Any(s => field(s) is not null))
|
||||
{
|
||||
into.Add(Blob(series, sensors, s => field(s) is { } v ? (float)v : SensorMissing));
|
||||
into.Add(Blob(series, sensors, hz, s => field(s) is { } v ? (float)v : SensorMissing));
|
||||
}
|
||||
}
|
||||
|
||||
private SensorBlob Blob(string series, IReadOnlyList<TelemetrySample> sensors, Func<TelemetrySample, float> value) => new()
|
||||
private SensorBlob Blob(string series, IReadOnlyList<TelemetrySample> sensors, double hz, Func<TelemetrySample, float> value) => new()
|
||||
{
|
||||
Series = series,
|
||||
|
||||
// Nominal: the poller ticks once a second by default (TelemetryPollerOptions). The t_ms series stored beside every
|
||||
// series carries each tick's real time, and that is what the App draws against; Hz is only its fallback for a row
|
||||
// written without t_ms (06_DATA_MODEL §sensor_blobs).
|
||||
Hz = 1,
|
||||
// The rate the samples had (SampleRate; it was the constant 1 until 0.1.0-beta.48, whatever the samples did).
|
||||
// The t_ms series stored beside every series carries each tick's real time, and that is what the App draws
|
||||
// against; Hz is only its fallback for a row written without t_ms (06_DATA_MODEL §sensor_blobs).
|
||||
Hz = hz,
|
||||
Codec = _codec.Tag,
|
||||
Data = _codec.EncodeFloat32([.. sensors.Select(value)]),
|
||||
};
|
||||
|
||||
@@ -374,7 +374,7 @@ public sealed class SessionRecorder : ISessionRecorder
|
||||
// What the game told its upscaler (train B): read inside the game by the Overlay, only for a session that
|
||||
// records Advanced metrics - the same condition the shared reader is held under.
|
||||
private readonly InGameAdvancedSampler? _inGame = advanced is null ? null : new InGameAdvancedSampler();
|
||||
private IReadOnlyList<AdvancedReading>? _inGamePending;
|
||||
private readonly PendingInGameReadings _inGamePending = new();
|
||||
private (IReadOnlyList<AdvancedFact> Facts, AdvancedInGameStatus Status, InGameCallStates Calls) _inGameContext =
|
||||
([], AdvancedInGameStatus.Unknown, default);
|
||||
private IReadOnlyList<AdvancedFact> _sessionWithGame = [];
|
||||
@@ -417,8 +417,9 @@ public sealed class SessionRecorder : ISessionRecorder
|
||||
FollowAdapter(progress.AdapterLuid);
|
||||
if (_inGame?.Take(progress.InGameAdvanced) is { } fresh)
|
||||
{
|
||||
// The newest stands until a telemetry sample carries it: both arrive once a second, out of step.
|
||||
_inGamePending = fresh;
|
||||
// It waits until a telemetry sample carries it: both arrive once a second, out of step - and it is no
|
||||
// longer replaced by the one after it (owner decision D150; PendingInGameReadings says why).
|
||||
_inGamePending.Offer(fresh);
|
||||
}
|
||||
|
||||
DrainTelemetry();
|
||||
@@ -521,6 +522,8 @@ public sealed class SessionRecorder : ISessionRecorder
|
||||
StreamlineAllocateResources = calls.AllocateResources,
|
||||
StreamlineFreeResources = calls.FreeResources,
|
||||
StreamlineShutdown = calls.Shutdown,
|
||||
DriverLatency = calls.Driver,
|
||||
DriverLatencySlowestUs = calls.DriverSlowestUs,
|
||||
}));
|
||||
}
|
||||
|
||||
@@ -548,7 +551,9 @@ public sealed class SessionRecorder : ISessionRecorder
|
||||
_inGame.FeatureCall(InGameAdvancedSampler.FeatureSwitched, hooks.HasFlag(FlHookFamily.SlSetFeatureLoaded)),
|
||||
_inGame.FeatureCall(InGameAdvancedSampler.FeatureAllocated, hooks.HasFlag(FlHookFamily.SlAllocateResources)),
|
||||
_inGame.FeatureCall(InGameAdvancedSampler.FeatureFreed, hooks.HasFlag(FlHookFamily.SlFreeResources)),
|
||||
_inGame.Call(FlAdvancedValid.SlShutdown, hooks.HasFlag(FlHookFamily.SlShutdown)));
|
||||
_inGame.Call(FlAdvancedValid.SlShutdown, hooks.HasFlag(FlHookFamily.SlShutdown)),
|
||||
_inGame.DriverRead(hooked: true),
|
||||
_inGame.DriverSlowestUs);
|
||||
}
|
||||
|
||||
/// <summary>The ten calls' states, compared as one value when deciding whether the session's context moved.</summary>
|
||||
@@ -563,7 +568,9 @@ public sealed class SessionRecorder : ISessionRecorder
|
||||
AdvancedInGameCall? SetFeatureLoaded,
|
||||
AdvancedInGameCall? AllocateResources,
|
||||
AdvancedInGameCall? FreeResources,
|
||||
AdvancedInGameCall? Shutdown);
|
||||
AdvancedInGameCall? Shutdown,
|
||||
AdvancedDriverRead? Driver,
|
||||
int? DriverSlowestUs);
|
||||
|
||||
/// <summary>
|
||||
/// What the row says of the entries read inside the game: read, measured inside the game with none of their
|
||||
@@ -625,13 +632,12 @@ public sealed class SessionRecorder : ISessionRecorder
|
||||
|
||||
_drained.Clear();
|
||||
poller.Drain(_drained);
|
||||
if (_inGamePending is { } pending && _drained.Count > 0)
|
||||
if (_drained.Count > 0 && _inGamePending.TryTake(out IReadOnlyList<AdvancedReading>? pending))
|
||||
{
|
||||
// What the game said rides the newest sample of this drain, beside whatever the Agent's own reader
|
||||
// gave it: one tick, one set of readings.
|
||||
// gave it: one tick, one set of readings - the oldest that waits.
|
||||
TelemetrySample newest = _drained[^1];
|
||||
_drained[^1] = newest with { Advanced = newest.Advanced is { Count: > 0 } own ? [.. own, .. pending] : pending };
|
||||
_inGamePending = null;
|
||||
}
|
||||
|
||||
writer.AddSensors(_drained);
|
||||
|
||||
@@ -3,6 +3,7 @@
|
||||
|
||||
using System.Runtime.InteropServices;
|
||||
using FrameLedger.Application.Advanced;
|
||||
using FrameLedger.Application.Input;
|
||||
|
||||
namespace FrameLedger.Application.Telemetry;
|
||||
|
||||
@@ -32,5 +33,11 @@ namespace FrameLedger.Application.Telemetry;
|
||||
/// was new at this poll, or null — the option is off, or that reader published nothing since the last poll. Null on
|
||||
/// every sample recorded before it existed. Never a repeat of an earlier tick's readings: a reading is of one tick.
|
||||
/// </param>
|
||||
/// <param name="Input">
|
||||
/// What the input reader saw for this session since the sample before (owner decisions of 2026-11-14,
|
||||
/// <c>21_INPUT_DEVICES</c>): how the time the game was in front divides between a controller, the keyboard and mouse,
|
||||
/// both and neither, and each controller's part. Null when the option is off, when the terms that say what is read
|
||||
/// were not accepted yet, and on every sample recorded before it existed.
|
||||
/// </param>
|
||||
[StructLayout(LayoutKind.Auto)]
|
||||
public readonly record struct TelemetrySample(long QpcTicks, GpuSample Sample, SystemReading System = default, ProcessReading Game = default, IReadOnlyList<AdvancedReading>? Advanced = null);
|
||||
public readonly record struct TelemetrySample(long QpcTicks, GpuSample Sample, SystemReading System = default, ProcessReading Game = default, IReadOnlyList<AdvancedReading>? Advanced = null, InputReading? Input = null);
|
||||
@@ -0,0 +1,28 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
using System.Runtime.InteropServices;
|
||||
|
||||
namespace FrameLedger.Domain.Input;
|
||||
|
||||
/// <summary>A controller's battery at one reading: what it was doing and how full it was, in the source's own steps.</summary>
|
||||
/// <param name="State">What the battery was doing.</param>
|
||||
/// <param name="Scale">What <paramref name="Level"/> counts in.</param>
|
||||
/// <param name="Level">The level in <paramref name="Scale"/>; 0 when the scale is <see cref="BatteryScale.None"/>.</param>
|
||||
[StructLayout(LayoutKind.Auto)]
|
||||
public readonly record struct BatteryReading(BatteryState State, BatteryScale Scale, int Level)
|
||||
{
|
||||
/// <summary>A wired controller: no battery.</summary>
|
||||
public static BatteryReading Wired { get; } = new(BatteryState.Wired, BatteryScale.None, 0);
|
||||
|
||||
/// <summary>
|
||||
/// Whether a player would call the level low while the controller runs on its battery: XInput's "empty" or "low",
|
||||
/// or 10 % and under. Never while it charges, and never for a reading with no level.
|
||||
/// </summary>
|
||||
public bool IsLow => State is BatteryState.Discharging or BatteryState.Unknown && Scale switch
|
||||
{
|
||||
BatteryScale.FourLevels => Level <= 1,
|
||||
BatteryScale.Percent => Level <= 10,
|
||||
_ => false,
|
||||
};
|
||||
}
|
||||
@@ -0,0 +1,17 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
namespace FrameLedger.Domain.Input;
|
||||
|
||||
/// <summary>What a <see cref="BatteryReading.Level"/> counts in: each source keeps its own steps, none is converted into another's.</summary>
|
||||
public enum BatteryScale
|
||||
{
|
||||
/// <summary>No level: a wired controller, or one that reported a state only.</summary>
|
||||
None = 0,
|
||||
|
||||
/// <summary>XInput's four words: 0 empty, 1 low, 2 medium, 3 full.</summary>
|
||||
FourLevels,
|
||||
|
||||
/// <summary>Per cent, 0 to 100 - a DualSense reports it in steps of ten.</summary>
|
||||
Percent,
|
||||
}
|
||||
@@ -0,0 +1,23 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
namespace FrameLedger.Domain.Input;
|
||||
|
||||
/// <summary>What a controller's battery was doing at one reading.</summary>
|
||||
public enum BatteryState
|
||||
{
|
||||
/// <summary>The controller reported a battery and not what it was doing, or reported a fault.</summary>
|
||||
Unknown = 0,
|
||||
|
||||
/// <summary>Running on its battery.</summary>
|
||||
Discharging,
|
||||
|
||||
/// <summary>Charging.</summary>
|
||||
Charging,
|
||||
|
||||
/// <summary>Charged and on power.</summary>
|
||||
Full,
|
||||
|
||||
/// <summary>A wired controller with no battery to report (XInput's word).</summary>
|
||||
Wired,
|
||||
}
|
||||
@@ -0,0 +1,11 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
namespace FrameLedger.Domain.Input;
|
||||
|
||||
/// <summary>One battery state a controller held during a session, and for how long.</summary>
|
||||
/// <param name="State">What the battery was doing.</param>
|
||||
/// <param name="Scale">What <paramref name="Level"/> counts in.</param>
|
||||
/// <param name="Level">The level, in <paramref name="Scale"/>.</param>
|
||||
/// <param name="Ms">The time it was read in this state, in milliseconds.</param>
|
||||
public sealed record BatteryStateTime(BatteryState State, BatteryScale Scale, int Level, long Ms);
|
||||
@@ -0,0 +1,27 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
namespace FrameLedger.Domain.Input;
|
||||
|
||||
/// <summary>What <see cref="BatteryTally"/> adds up to for one controller.</summary>
|
||||
public sealed record BatterySummary
|
||||
{
|
||||
/// <summary>Every state the battery was read in, the longest first.</summary>
|
||||
public IReadOnlyList<BatteryStateTime> States { get; init; } = [];
|
||||
|
||||
/// <summary>The state that lasted longest - the first of <see cref="States"/> - or null when nothing was read.</summary>
|
||||
public BatteryStateTime? Longest => States.Count > 0 ? States[0] : null;
|
||||
|
||||
/// <summary>The first reading of the session.</summary>
|
||||
public BatteryReading? First { get; init; }
|
||||
|
||||
/// <summary>The last reading of the session.</summary>
|
||||
public BatteryReading? Last { get; init; }
|
||||
|
||||
/// <summary>
|
||||
/// How fast the battery ran down, in per cent an hour: the fall between the first and the last reading on battery
|
||||
/// over the time read on battery. Null unless the level is in per cent, it fell, it was not put on power in
|
||||
/// between, and at least <see cref="BatteryTally.MinimumDrainTime"/> was read on battery.
|
||||
/// </summary>
|
||||
public double? DrainPercentPerHour { get; init; }
|
||||
}
|
||||
@@ -0,0 +1,76 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
namespace FrameLedger.Domain.Input;
|
||||
|
||||
/// <summary>
|
||||
/// One controller's battery readings over a session, accumulated by the time each stood for (<c>03_METRICS</c> §Input):
|
||||
/// how long it spent at each level, which lasted longest, where it started and ended, and how fast it ran down.
|
||||
/// </summary>
|
||||
public sealed class BatteryTally
|
||||
{
|
||||
/// <summary>The least time on battery a rate is worked out over: a level moves in steps of ten, and less says nothing.</summary>
|
||||
public static readonly TimeSpan MinimumDrainTime = TimeSpan.FromMinutes(10);
|
||||
|
||||
private readonly Dictionary<BatteryReading, long> _ms = [];
|
||||
private BatteryReading? _first;
|
||||
private BatteryReading? _last;
|
||||
private int? _drainFrom;
|
||||
private int _drainTo;
|
||||
private long _drainMs;
|
||||
private bool _drainBroken;
|
||||
|
||||
/// <summary>Whether any reading was added.</summary>
|
||||
public bool Any => _first is not null;
|
||||
|
||||
/// <summary>Adds one reading that stood for <paramref name="elapsedMs"/> milliseconds (negative is treated as 0).</summary>
|
||||
public void Add(BatteryReading reading, long elapsedMs)
|
||||
{
|
||||
long ms = Math.Max(0, elapsedMs);
|
||||
_ms[reading] = _ms.GetValueOrDefault(reading) + ms;
|
||||
_first ??= reading;
|
||||
_last = reading;
|
||||
if (reading.Scale != BatteryScale.Percent)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
if (reading.State == BatteryState.Discharging)
|
||||
{
|
||||
_drainFrom ??= reading.Level;
|
||||
_drainTo = reading.Level;
|
||||
_drainMs += ms;
|
||||
}
|
||||
else if (_drainFrom is not null && reading.State is BatteryState.Charging or BatteryState.Full)
|
||||
{
|
||||
// It was put on power after it had begun to run down: the fall between first and last is not one run.
|
||||
_drainBroken = true;
|
||||
}
|
||||
}
|
||||
|
||||
public BatterySummary Summary()
|
||||
{
|
||||
BatteryStateTime[] states = [.. _ms
|
||||
.Select(static p => new BatteryStateTime(p.Key.State, p.Key.Scale, p.Key.Level, p.Value))
|
||||
.OrderByDescending(static s => s.Ms)
|
||||
.ThenBy(static s => s.State)
|
||||
.ThenByDescending(static s => s.Level)];
|
||||
return new BatterySummary
|
||||
{
|
||||
States = states,
|
||||
First = _first,
|
||||
Last = _last,
|
||||
DrainPercentPerHour = Drain(),
|
||||
};
|
||||
}
|
||||
|
||||
private double? Drain()
|
||||
{
|
||||
if (_drainBroken || _drainFrom is not { } from || from <= _drainTo || _drainMs < MinimumDrainTime.TotalMilliseconds)
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
return Math.Round((from - _drainTo) / (_drainMs / 3_600_000d), 1);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,72 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
namespace FrameLedger.Domain.Input;
|
||||
|
||||
/// <summary>
|
||||
/// What a controller's USB vendor and product ids say about it (<c>21_INPUT_DEVICES</c> §Who a controller is): its
|
||||
/// family, a model name for the ones this build knows, and whether it is a pad a program presents rather than one a
|
||||
/// player holds. The ids are the only thing read of a device's identity - never a serial number, never an address.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// The model names are product names, the same in every language. A product id that is not listed has no name, and the
|
||||
/// App then shows the family and the two ids: a wrong name would be worse than none.
|
||||
/// </remarks>
|
||||
public static class ControllerCatalog
|
||||
{
|
||||
public const int Microsoft = 0x045E;
|
||||
|
||||
public const int Sony = 0x054C;
|
||||
|
||||
public const int Nintendo = 0x057E;
|
||||
|
||||
public const int Valve = 0x28DE;
|
||||
|
||||
/// <summary>The Xbox 360 pad the Steam client presents when Steam Input stands between a controller and a game.</summary>
|
||||
public const int SteamVirtualGamepad = 0x11FF;
|
||||
|
||||
public const int DualSense = 0x0CE6;
|
||||
|
||||
public const int DualSenseEdge = 0x0DF2;
|
||||
|
||||
private static readonly Dictionary<(int Vendor, int Product), string> _models = new()
|
||||
{
|
||||
[(Microsoft, 0x028E)] = "Xbox 360 Controller",
|
||||
[(Microsoft, 0x028F)] = "Xbox 360 Wireless Controller",
|
||||
[(Microsoft, 0x02D1)] = "Xbox One Controller",
|
||||
[(Microsoft, 0x02DD)] = "Xbox One Controller",
|
||||
[(Microsoft, 0x02E3)] = "Xbox Elite Wireless Controller",
|
||||
[(Microsoft, 0x02EA)] = "Xbox One S Controller",
|
||||
[(Microsoft, 0x02FD)] = "Xbox One S Controller",
|
||||
[(Microsoft, 0x0B00)] = "Xbox Elite Wireless Controller Series 2",
|
||||
[(Microsoft, 0x0B05)] = "Xbox Elite Wireless Controller Series 2",
|
||||
[(Microsoft, 0x0B22)] = "Xbox Elite Wireless Controller Series 2",
|
||||
[(Microsoft, 0x0B12)] = "Xbox Wireless Controller",
|
||||
[(Microsoft, 0x0B13)] = "Xbox Wireless Controller",
|
||||
[(Microsoft, 0x0B20)] = "Xbox Wireless Controller",
|
||||
[(Sony, 0x05C4)] = "DualShock 4",
|
||||
[(Sony, 0x09CC)] = "DualShock 4",
|
||||
[(Sony, DualSense)] = "DualSense",
|
||||
[(Sony, DualSenseEdge)] = "DualSense Edge",
|
||||
[(Nintendo, 0x2009)] = "Switch Pro Controller",
|
||||
[(Valve, SteamVirtualGamepad)] = "Steam Virtual Gamepad",
|
||||
};
|
||||
|
||||
/// <summary>The family of a device with this vendor id; a device Windows presents through XInput is <see cref="ControllerFamily.Xbox"/> whoever made it.</summary>
|
||||
public static ControllerFamily FamilyOf(int vendorId, bool xinput) => vendorId switch
|
||||
{
|
||||
Microsoft => ControllerFamily.Xbox,
|
||||
Sony => ControllerFamily.PlayStation,
|
||||
Nintendo => ControllerFamily.Nintendo,
|
||||
_ => xinput ? ControllerFamily.Xbox : ControllerFamily.Other,
|
||||
};
|
||||
|
||||
/// <summary>The model's product name, or null for ids this build does not list.</summary>
|
||||
public static string? ModelOf(int vendorId, int productId) => _models.GetValueOrDefault((vendorId, productId));
|
||||
|
||||
/// <summary>Whether the ids are those of a pad a program presents - Steam's - rather than one a player holds.</summary>
|
||||
public static bool IsVirtual(int vendorId, int productId) => vendorId == Valve && productId == SteamVirtualGamepad;
|
||||
|
||||
/// <summary>Whether the ids are a DualSense's or a DualSense Edge's, whose reports <see cref="DualSenseReport"/> reads.</summary>
|
||||
public static bool IsDualSense(int vendorId, int productId) => vendorId == Sony && productId is DualSense or DualSenseEdge;
|
||||
}
|
||||
@@ -0,0 +1,20 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
namespace FrameLedger.Domain.Input;
|
||||
|
||||
/// <summary>How a controller reached the PC, as far as Windows says.</summary>
|
||||
public enum ControllerConnection
|
||||
{
|
||||
/// <summary>Nothing said how.</summary>
|
||||
Unknown = 0,
|
||||
|
||||
/// <summary>A cable.</summary>
|
||||
Usb,
|
||||
|
||||
/// <summary>Bluetooth, classic or low energy.</summary>
|
||||
Bluetooth,
|
||||
|
||||
/// <summary>A wireless link that is not known to be Bluetooth - XInput's own word, with no more detail.</summary>
|
||||
Wireless,
|
||||
}
|
||||
@@ -0,0 +1,24 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
namespace FrameLedger.Domain.Input;
|
||||
|
||||
/// <summary>
|
||||
/// Whose controller a device is, from its USB vendor id (<c>03_METRICS</c> §Input). <see cref="Xbox"/> is also what
|
||||
/// Windows presents through XInput with no vendor id: a pad of another maker that says it is an Xbox pad is one here,
|
||||
/// because that is all Windows tells.
|
||||
/// </summary>
|
||||
public enum ControllerFamily
|
||||
{
|
||||
/// <summary>A game controller of a maker this build has no name for.</summary>
|
||||
Other = 0,
|
||||
|
||||
/// <summary>Microsoft's, and every pad Windows presents through XInput with no vendor id.</summary>
|
||||
Xbox,
|
||||
|
||||
/// <summary>Sony's: DualSense, DualSense Edge, DualShock 4.</summary>
|
||||
PlayStation,
|
||||
|
||||
/// <summary>Nintendo's.</summary>
|
||||
Nintendo,
|
||||
}
|
||||
@@ -0,0 +1,133 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
namespace FrameLedger.Domain.Input;
|
||||
|
||||
/// <summary>
|
||||
/// What one input report of a DualSense says that a session keeps (<c>21_INPUT_DEVICES</c> §DualSense): whether
|
||||
/// anything on the pad was in use, and its battery when the report carries one. The buttons and sticks are looked at to
|
||||
/// answer the first and are not returned - nothing here can say which was pressed.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// <b>Three reports.</b> Over USB the pad sends report <c>0x01</c>, 64 bytes. Over Bluetooth it sends a short report
|
||||
/// <c>0x01</c> of 10 bytes - sticks, buttons and triggers, no battery - until some program asks it for a feature report
|
||||
/// or sends it an output report; from then until it reconnects it sends report <c>0x31</c>, 78 bytes, whose body is the
|
||||
/// USB one moved by one byte. FrameLedger never asks: a game that reads the short report would lose its input (owner
|
||||
/// decision, 2026-11-14). So over Bluetooth the battery is there only when Steam or the game switched the pad.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// The layout is the one the pad's makers' drivers and the open descriptions of the protocol agree on; it was written
|
||||
/// from those descriptions, and <b>no report from a real pad had passed through it when it was written</b>.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public static class DualSenseReport
|
||||
{
|
||||
public const int UsbLength = 64;
|
||||
|
||||
public const int BluetoothShortLength = 10;
|
||||
|
||||
public const int BluetoothLength = 78;
|
||||
|
||||
/// <summary>How far a stick must be from its centre (128) to count: a quarter of its travel, as XInput's own dead zone is.</summary>
|
||||
public const int StickDeadzone = 32;
|
||||
|
||||
/// <summary>How far a trigger must be pulled (0-255) to count: XInput's threshold.</summary>
|
||||
public const int TriggerThreshold = 30;
|
||||
|
||||
private const int _usbReportId = 0x01;
|
||||
private const int _bluetoothReportId = 0x31;
|
||||
private const int _hatNeutral = 8;
|
||||
|
||||
// Offsets in the full report's body, which starts after the report id over USB and one byte later over Bluetooth.
|
||||
private const int _fullTriggers = 4;
|
||||
private const int _fullButtons = 7;
|
||||
private const int _fullStatus = 52;
|
||||
private const int _fullBodyLength = 53;
|
||||
|
||||
/// <summary>Reads one report; false for anything that is not one of the three, which is then not counted as a report of this pad.</summary>
|
||||
/// <param name="report">The report as Windows hands it over, its id first.</param>
|
||||
/// <param name="bluetooth">
|
||||
/// Whether the pad is on Bluetooth. The length cannot say: Windows hands every report of a device over at the length
|
||||
/// of its longest, so the short Bluetooth report arrives padded to 78 bytes with the same id as the USB one.
|
||||
/// </param>
|
||||
/// <param name="active">Whether anything on the pad was in use.</param>
|
||||
/// <param name="battery">The battery, when the report carries it.</param>
|
||||
public static bool TryRead(ReadOnlySpan<byte> report, bool bluetooth, out bool active, out BatteryReading? battery)
|
||||
{
|
||||
active = false;
|
||||
battery = null;
|
||||
if (report.IsEmpty)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
if (!bluetooth)
|
||||
{
|
||||
if (report.Length < 1 + _fullBodyLength || report[0] != _usbReportId)
|
||||
{
|
||||
return false;
|
||||
}
|
||||
|
||||
ReadFull(report[1..], out active, out battery);
|
||||
return true;
|
||||
}
|
||||
|
||||
if (report[0] == _bluetoothReportId && report.Length >= 2 + _fullBodyLength)
|
||||
{
|
||||
ReadFull(report[2..], out active, out battery);
|
||||
return true;
|
||||
}
|
||||
|
||||
if (report[0] == _usbReportId && report.Length >= BluetoothShortLength)
|
||||
{
|
||||
// x, y, rx, ry, three bytes of buttons (the third's upper six bits are a counter), the two triggers.
|
||||
active = SticksMoved(report[1..5]) || ButtonsDown(report[5], report[6], report[7] & 0x03) || TriggersPulled(report[8], report[9]);
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
private static void ReadFull(ReadOnlySpan<byte> body, out bool active, out BatteryReading? battery)
|
||||
{
|
||||
// x, y, rx, ry, the two triggers, a counter, then the buttons: hat and face, shoulders and sticks, the rest.
|
||||
active = SticksMoved(body[..4])
|
||||
|| TriggersPulled(body[_fullTriggers], body[_fullTriggers + 1])
|
||||
|| ButtonsDown(body[_fullButtons], body[_fullButtons + 1], body[_fullButtons + 2]);
|
||||
battery = BatteryOf(body[_fullStatus]);
|
||||
}
|
||||
|
||||
private static bool SticksMoved(ReadOnlySpan<byte> axes)
|
||||
{
|
||||
foreach (byte axis in axes)
|
||||
{
|
||||
if (Math.Abs(axis - 128) > StickDeadzone)
|
||||
{
|
||||
return true;
|
||||
}
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
private static bool TriggersPulled(byte left, byte right) => left > TriggerThreshold || right > TriggerThreshold;
|
||||
|
||||
private static bool ButtonsDown(byte hatAndFace, byte shoulders, int rest) =>
|
||||
(hatAndFace & 0x0F) < _hatNeutral || (hatAndFace & 0xF0) != 0 || shoulders != 0 || rest != 0;
|
||||
|
||||
/// <summary>The status byte: the low four bits are the level in tenths (10 is 100 %), the high four what the battery is doing.</summary>
|
||||
private static BatteryReading BatteryOf(byte status)
|
||||
{
|
||||
int level = Math.Min(status & 0x0F, 10) * 10;
|
||||
return (status >> 4) switch
|
||||
{
|
||||
0x0 => new BatteryReading(BatteryState.Discharging, BatteryScale.Percent, level),
|
||||
0x1 => new BatteryReading(BatteryState.Charging, BatteryScale.Percent, level),
|
||||
0x2 => new BatteryReading(BatteryState.Full, BatteryScale.Percent, 100),
|
||||
|
||||
// 0xA and 0xB are "not charging" for voltage or temperature, 0xF a charging fault: a level and no state.
|
||||
_ => new BatteryReading(BatteryState.Unknown, BatteryScale.Percent, level),
|
||||
};
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,24 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
namespace FrameLedger.Domain.Input;
|
||||
|
||||
/// <summary>
|
||||
/// What a stretch of a session was played with (<c>03_METRICS</c> §Input): decided for each slice of time the game was
|
||||
/// in front, from outside the game. It says a device was in use while the game was in front, never what the game did
|
||||
/// with it.
|
||||
/// </summary>
|
||||
public enum InputClass
|
||||
{
|
||||
/// <summary>Neither a controller nor the keyboard or mouse was in use.</summary>
|
||||
None = 0,
|
||||
|
||||
/// <summary>A controller was in use and the keyboard and mouse were not.</summary>
|
||||
Controller,
|
||||
|
||||
/// <summary>The keyboard or the mouse was in use and no controller was. The two are one class: only the time of the last input is read.</summary>
|
||||
KeyboardMouse,
|
||||
|
||||
/// <summary>A controller and the keyboard or mouse were both in use.</summary>
|
||||
Both,
|
||||
}
|
||||
@@ -0,0 +1,79 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
namespace FrameLedger.Domain.Input;
|
||||
|
||||
/// <summary>
|
||||
/// How many times a session went from one thing to another (<c>03_METRICS</c> §Input): from a controller to the
|
||||
/// keyboard and mouse and back, or from one maker's controller to another's.
|
||||
/// </summary>
|
||||
public static class InputSwitches
|
||||
{
|
||||
/// <summary>
|
||||
/// The number of changes in a sequence of ticks, where each tick is either one value or nothing. A tick with
|
||||
/// nothing - no input, or two things at once - is skipped and does not end what came before it: a player who puts
|
||||
/// the controller down, waits, and picks it up again has not switched.
|
||||
/// </summary>
|
||||
public static int Count<T>(IEnumerable<T?> ticks)
|
||||
where T : struct
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(ticks);
|
||||
int switches = 0;
|
||||
T? previous = null;
|
||||
foreach (T? tick in ticks)
|
||||
{
|
||||
if (tick is not { } now)
|
||||
{
|
||||
continue;
|
||||
}
|
||||
|
||||
if (previous is { } before && !EqualityComparer<T>.Default.Equals(before, now))
|
||||
{
|
||||
switches++;
|
||||
}
|
||||
|
||||
previous = now;
|
||||
}
|
||||
|
||||
return switches;
|
||||
}
|
||||
|
||||
/// <summary>The one class a tick was played with, or null when it was played with both or with neither.</summary>
|
||||
public static InputClass? Exclusive(long controllerMs, long keyboardMouseMs, long bothMs)
|
||||
{
|
||||
if (bothMs > 0 || (controllerMs > 0 && keyboardMouseMs > 0))
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
if (controllerMs > 0)
|
||||
{
|
||||
return InputClass.Controller;
|
||||
}
|
||||
|
||||
return keyboardMouseMs > 0 ? InputClass.KeyboardMouse : null;
|
||||
}
|
||||
|
||||
/// <summary>The class a tick was mostly played with - what its point on the timeline shows - or null when the game was not in front at all.</summary>
|
||||
public static InputClass? Dominant(long controllerMs, long keyboardMouseMs, long bothMs, long idleMs)
|
||||
{
|
||||
if (controllerMs + keyboardMouseMs + bothMs + idleMs <= 0)
|
||||
{
|
||||
return null;
|
||||
}
|
||||
|
||||
InputClass best = InputClass.None;
|
||||
long most = idleMs;
|
||||
if (keyboardMouseMs > most)
|
||||
{
|
||||
(best, most) = (InputClass.KeyboardMouse, keyboardMouseMs);
|
||||
}
|
||||
|
||||
if (controllerMs > most)
|
||||
{
|
||||
(best, most) = (InputClass.Controller, controllerMs);
|
||||
}
|
||||
|
||||
return bothMs > most ? InputClass.Both : best;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,49 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
namespace FrameLedger.Domain.Input;
|
||||
|
||||
/// <summary>
|
||||
/// The two things FrameLedger takes from the name Windows gives a controller's device interface, after which the name
|
||||
/// is dropped (<c>21_INPUT_DEVICES</c> §What is never read): whether Windows presents the device through XInput, and
|
||||
/// how it is connected.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// The name is a path such as <c>\\?\HID#VID_045E&PID_0B12&IG_00#…</c>. On Bluetooth it carries the service's
|
||||
/// identifier - and, further along, an instance id that on some stacks is derived from the device's address. That is
|
||||
/// why the name is never kept, logged or stored: this type returns two facts and holds no string.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <b><c>IG_</c></b> is Microsoft's documented mark of a device XInput presents ("XInput and DirectInput": a device id
|
||||
/// that contains <c>IG_</c> is an XInput device). <b>The connection</b> is Bluetooth when the name carries the
|
||||
/// identifier of the Bluetooth HID service, classic (<c>00001124-…</c>) or low energy (<c>00001812-…</c>), and USB
|
||||
/// when it carries a USB vendor id written <c>VID_</c>; anything else is not known.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public static class RawDeviceName
|
||||
{
|
||||
private const string _xinputMark = "IG_";
|
||||
private const string _bluetoothClassicService = "{00001124-0000-1000-8000-00805f9b34fb}";
|
||||
private const string _bluetoothLowEnergyService = "{00001812-0000-1000-8000-00805f9b34fb}";
|
||||
private const string _usbVendor = "VID_";
|
||||
|
||||
/// <summary>Whether Windows presents the device through XInput.</summary>
|
||||
public static bool IsXInputClass(string? name) => name is not null && name.Contains(_xinputMark, StringComparison.OrdinalIgnoreCase);
|
||||
|
||||
/// <summary>How the device is connected, as far as its name says.</summary>
|
||||
public static ControllerConnection ConnectionOf(string? name)
|
||||
{
|
||||
if (string.IsNullOrEmpty(name))
|
||||
{
|
||||
return ControllerConnection.Unknown;
|
||||
}
|
||||
|
||||
if (name.Contains(_bluetoothClassicService, StringComparison.OrdinalIgnoreCase) || name.Contains(_bluetoothLowEnergyService, StringComparison.OrdinalIgnoreCase))
|
||||
{
|
||||
return ControllerConnection.Bluetooth;
|
||||
}
|
||||
|
||||
return name.Contains(_usbVendor, StringComparison.OrdinalIgnoreCase) ? ControllerConnection.Usb : ControllerConnection.Unknown;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,67 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
namespace FrameLedger.Domain.Input;
|
||||
|
||||
/// <summary>
|
||||
/// Whether two entries of a session's controller list are one pad seen twice (<c>03_METRICS</c> §Input). With Steam
|
||||
/// Input between a controller and a game, Windows shows the controller the player holds and an Xbox pad Steam presents
|
||||
/// for it; both move together. Counted as two, a session would have twice the controllers and a share for a maker
|
||||
/// nobody held.
|
||||
/// </summary>
|
||||
public static class VirtualPad
|
||||
{
|
||||
/// <summary>How much of the busier entry's time the other must share for the two to be one pad.</summary>
|
||||
public const double MergeAt = 0.9;
|
||||
|
||||
/// <summary>The least time in use the two must have: a few seconds moving together prove nothing.</summary>
|
||||
public const long MinimumActiveMs = 10_000;
|
||||
|
||||
/// <summary>
|
||||
/// How much two controllers were in use at the same moments: the time both were in use over the time the busier of
|
||||
/// the two was, 0 to 1. Each array holds a controller's milliseconds in use for every tick of the session, tick for
|
||||
/// tick.
|
||||
/// </summary>
|
||||
public static double Coincidence(ReadOnlySpan<int> a, ReadOnlySpan<int> b)
|
||||
{
|
||||
long together = 0;
|
||||
long sumA = 0;
|
||||
long sumB = 0;
|
||||
int n = Math.Min(a.Length, b.Length);
|
||||
for (int i = 0; i < n; i++)
|
||||
{
|
||||
together += Math.Min(a[i], b[i]);
|
||||
}
|
||||
|
||||
foreach (int ms in a)
|
||||
{
|
||||
sumA += ms;
|
||||
}
|
||||
|
||||
foreach (int ms in b)
|
||||
{
|
||||
sumB += ms;
|
||||
}
|
||||
|
||||
long busier = Math.Max(sumA, sumB);
|
||||
return busier <= 0 ? 0 : (double)together / busier;
|
||||
}
|
||||
|
||||
/// <summary>Whether the two are one pad: they were in use for long enough, and at the same moments.</summary>
|
||||
public static bool IsSamePad(ReadOnlySpan<int> a, ReadOnlySpan<int> b)
|
||||
{
|
||||
long sumA = 0;
|
||||
long sumB = 0;
|
||||
foreach (int ms in a)
|
||||
{
|
||||
sumA += ms;
|
||||
}
|
||||
|
||||
foreach (int ms in b)
|
||||
{
|
||||
sumB += ms;
|
||||
}
|
||||
|
||||
return Math.Min(sumA, sumB) >= MinimumActiveMs && Coincidence(a, b) >= MergeAt;
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,50 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
namespace FrameLedger.Domain.Input;
|
||||
|
||||
/// <summary>
|
||||
/// What XInput's answers about one of its four pads mean to a session (<c>21_INPUT_DEVICES</c> §XInput): whether the
|
||||
/// state it returned is a pad in use, and what its battery words are. The thresholds are the ones XInput's own header
|
||||
/// recommends, so "in use" here is what a game written to that header would call input.
|
||||
/// </summary>
|
||||
public static class XInputPad
|
||||
{
|
||||
/// <summary><c>XINPUT_GAMEPAD_LEFT_THUMB_DEADZONE</c>.</summary>
|
||||
public const int LeftThumbDeadzone = 7849;
|
||||
|
||||
/// <summary><c>XINPUT_GAMEPAD_RIGHT_THUMB_DEADZONE</c>.</summary>
|
||||
public const int RightThumbDeadzone = 8689;
|
||||
|
||||
/// <summary><c>XINPUT_GAMEPAD_TRIGGER_THRESHOLD</c>.</summary>
|
||||
public const int TriggerThreshold = 30;
|
||||
|
||||
private const int _typeWired = 0x01;
|
||||
private const int _typeAlkaline = 0x02;
|
||||
private const int _typeNimh = 0x03;
|
||||
private const int _levelFull = 0x03;
|
||||
|
||||
/// <summary>Whether a state is a pad in use: a button down, a trigger past the threshold, or a stick outside its dead zone. A stick held counts; one that drifts inside the dead zone does not.</summary>
|
||||
public static bool IsActive(int buttons, int leftTrigger, int rightTrigger, int thumbLx, int thumbLy, int thumbRx, int thumbRy) =>
|
||||
buttons != 0
|
||||
|| leftTrigger > TriggerThreshold
|
||||
|| rightTrigger > TriggerThreshold
|
||||
|| Outside(thumbLx, thumbLy, LeftThumbDeadzone)
|
||||
|| Outside(thumbRx, thumbRy, RightThumbDeadzone);
|
||||
|
||||
/// <summary>
|
||||
/// <c>XINPUT_BATTERY_INFORMATION</c> as a reading: null for "disconnected" and for a type this build does not know,
|
||||
/// <see cref="BatteryReading.Wired"/> for a wired pad, and the four levels for a battery. XInput does not say whether
|
||||
/// a battery charges, so one that is not wired is read as discharging.
|
||||
/// </summary>
|
||||
public static BatteryReading? Battery(int type, int level) => type switch
|
||||
{
|
||||
_typeWired => BatteryReading.Wired,
|
||||
_typeAlkaline or _typeNimh => new BatteryReading(BatteryState.Discharging, BatteryScale.FourLevels, Math.Clamp(level, 0, _levelFull)),
|
||||
|
||||
// 0 is XInput's "disconnected" and 0xFF its "unknown": neither is a battery to show.
|
||||
_ => null,
|
||||
};
|
||||
|
||||
private static bool Outside(int x, int y, int deadzone) => ((long)x * x) + ((long)y * y) > (long)deadzone * deadzone;
|
||||
}
|
||||
@@ -0,0 +1,253 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
using System.Diagnostics;
|
||||
using System.Diagnostics.CodeAnalysis;
|
||||
using System.Globalization;
|
||||
using FrameLedger.Application.Input;
|
||||
using FrameLedger.Application.Telemetry;
|
||||
|
||||
namespace FrameLedger.Infrastructure.Input;
|
||||
|
||||
/// <summary>
|
||||
/// The Agent's one input reader, on a thread of its own, running only while a session has a view of it (owner
|
||||
/// decisions D155-D163, <c>21_INPUT_DEVICES</c> §The reader). With no session it has no thread, no window and no
|
||||
/// registration: FrameLedger reads nothing about a controller, the keyboard or the mouse.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// <b>One reader, several sessions.</b> Sessions run side by side (the watcher keeps a table of them), and a
|
||||
/// controller's reports arrive once. So the thread makes one <see cref="InputSlice"/> about ten times a second and
|
||||
/// hands it to every view; each view counts it for its own session when a window of that session's game was in front
|
||||
/// (<see cref="InputTickAccumulator"/>).
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <b>A pause is a gap here too.</b> While recording is paused (FR-3.9) a slice is not observed by any session.
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <b>A slice that throws is counted and skipped</b>; <see cref="MaxFaults"/> in a row end the run with one line in
|
||||
/// the Agent's log, and the sessions go on without readings. Nothing the reader does may end a session.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public sealed class InputDeviceHub : IInputDevices, IDisposable
|
||||
{
|
||||
/// <summary>Slices that may throw in a row before the run ends.</summary>
|
||||
public const int MaxFaults = 20;
|
||||
|
||||
/// <summary>How long a slice is.</summary>
|
||||
public static readonly TimeSpan SliceInterval = TimeSpan.FromMilliseconds(100);
|
||||
|
||||
private readonly Lock _gate = new();
|
||||
private readonly Func<IInputBackend> _backendFactory;
|
||||
private readonly Func<bool> _paused;
|
||||
private readonly TimeSpan _interval;
|
||||
private readonly Action<string> _note;
|
||||
private readonly ManualResetEventSlim _wake = new(initialState: false);
|
||||
private readonly List<View> _views = [];
|
||||
private Thread? _thread;
|
||||
private bool _disposed;
|
||||
|
||||
/// <summary>A hub that reads nothing until a view of it is opened.</summary>
|
||||
/// <param name="backendFactory">Makes the Windows side a run uses; called on the hub's thread, once per run.</param>
|
||||
/// <param name="paused">Whether recording is paused now; null is never.</param>
|
||||
/// <param name="interval">How long a slice is; null is <see cref="SliceInterval"/>.</param>
|
||||
/// <param name="note">Told, in one line, when a run ends - the Agent's log. No line names a device.</param>
|
||||
public InputDeviceHub(Func<IInputBackend> backendFactory, Func<bool>? paused = null, TimeSpan? interval = null, Action<string>? note = null)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(backendFactory);
|
||||
_backendFactory = backendFactory;
|
||||
_paused = paused ?? (static () => false);
|
||||
_interval = interval ?? SliceInterval;
|
||||
ArgumentOutOfRangeException.ThrowIfLessThanOrEqual(_interval, TimeSpan.Zero, nameof(interval));
|
||||
_note = note ?? (static _ => { });
|
||||
}
|
||||
|
||||
/// <summary>Whether a run is in progress.</summary>
|
||||
public bool IsRunning
|
||||
{
|
||||
get
|
||||
{
|
||||
lock (_gate)
|
||||
{
|
||||
return _thread is not null;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
public IInputActivitySource Open()
|
||||
{
|
||||
var view = new View(this);
|
||||
lock (_gate)
|
||||
{
|
||||
ObjectDisposedException.ThrowIf(_disposed, this);
|
||||
_views.Add(view);
|
||||
if (_thread is null)
|
||||
{
|
||||
_thread = new Thread(Run) { IsBackground = true, Name = "fl-input" };
|
||||
_thread.Start();
|
||||
}
|
||||
}
|
||||
|
||||
return view;
|
||||
}
|
||||
|
||||
public void Dispose()
|
||||
{
|
||||
Thread? thread;
|
||||
lock (_gate)
|
||||
{
|
||||
if (_disposed)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
_disposed = true;
|
||||
thread = _thread;
|
||||
}
|
||||
|
||||
_wake.Set();
|
||||
if (thread is not null && thread != Thread.CurrentThread)
|
||||
{
|
||||
thread.Join(TimeSpan.FromSeconds(5));
|
||||
}
|
||||
|
||||
_wake.Dispose();
|
||||
}
|
||||
|
||||
private void Close(View view)
|
||||
{
|
||||
lock (_gate)
|
||||
{
|
||||
_views.Remove(view);
|
||||
}
|
||||
}
|
||||
|
||||
private void Run()
|
||||
{
|
||||
IInputBackend? backend = null;
|
||||
InputHealth last = new();
|
||||
try
|
||||
{
|
||||
backend = _backendFactory();
|
||||
var reader = new InputReader(backend);
|
||||
reader.Open();
|
||||
long before = Stopwatch.GetTimestamp();
|
||||
int faults = 0;
|
||||
while (Wait())
|
||||
{
|
||||
long now = Stopwatch.GetTimestamp();
|
||||
int elapsed = (int)Math.Min(Stopwatch.GetElapsedTime(before, now).TotalMilliseconds, int.MaxValue);
|
||||
before = now;
|
||||
try
|
||||
{
|
||||
InputSlice slice = reader.Slice(elapsed);
|
||||
last = slice.Health;
|
||||
faults = 0;
|
||||
Hand(slice);
|
||||
}
|
||||
catch (Exception e) when (e is not OperationCanceledException)
|
||||
{
|
||||
reader.Fault();
|
||||
if (++faults >= MaxFaults)
|
||||
{
|
||||
_note($"input: the reader's slice threw {MaxFaults} times running and the run ends ({e.GetType().Name}: {e.Message})");
|
||||
break;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
catch (Exception e) when (e is not OperationCanceledException)
|
||||
{
|
||||
_note($"input: the reader did not start ({e.GetType().Name}: {e.Message})");
|
||||
}
|
||||
finally
|
||||
{
|
||||
lock (_gate)
|
||||
{
|
||||
if (ReferenceEquals(_thread, Thread.CurrentThread))
|
||||
{
|
||||
_thread = null;
|
||||
}
|
||||
}
|
||||
|
||||
backend?.Dispose();
|
||||
_note(Summary(last));
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>What a run did, as the Agent's log keeps it: counts and yes-or-no answers, nothing of any device.</summary>
|
||||
private static string Summary(InputHealth h) => string.Create(CultureInfo.InvariantCulture,
|
||||
$"input: run ended - slices {h.Slices}, raw input {(h.RawInputRegistered ? "registered" : "NOT registered")}, reports {h.RawReports} ({h.RawReportsUnread} not read), "
|
||||
+ $"xinput {(h.XInputAvailable ? "there" : "absent")} with {h.XInputReads} reads and {h.XInputSilent} silent slices, last input {(h.LastInputAvailable ? "read" : "NOT read")}, "
|
||||
+ $"thread cpu {h.ThreadCpuMs} ms, faults {h.Faults}");
|
||||
|
||||
/// <summary>Waits a slice; false when the run is over - the hub is disposed, or no view is open.</summary>
|
||||
private bool Wait()
|
||||
{
|
||||
try
|
||||
{
|
||||
_wake.Wait(_interval);
|
||||
}
|
||||
catch (ObjectDisposedException)
|
||||
{
|
||||
// Dispose gave up waiting for this thread and released the event.
|
||||
return false;
|
||||
}
|
||||
|
||||
lock (_gate)
|
||||
{
|
||||
if (!_disposed && _views.Count > 0)
|
||||
{
|
||||
return true;
|
||||
}
|
||||
|
||||
// Decided under the lock and the slot cleared in the same step, so an Open that arrives a moment later
|
||||
// starts a run of its own rather than joining one that is closing.
|
||||
if (ReferenceEquals(_thread, Thread.CurrentThread))
|
||||
{
|
||||
_thread = null;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
}
|
||||
|
||||
private void Hand(InputSlice slice)
|
||||
{
|
||||
View[] views;
|
||||
lock (_gate)
|
||||
{
|
||||
views = [.. _views];
|
||||
}
|
||||
|
||||
bool paused = _paused();
|
||||
foreach (View view in views)
|
||||
{
|
||||
view.Add(slice, paused);
|
||||
}
|
||||
}
|
||||
|
||||
/// <summary>One session's view.</summary>
|
||||
private sealed class View(InputDeviceHub hub) : IInputActivitySource
|
||||
{
|
||||
private readonly InputTickAccumulator _sum = new();
|
||||
private volatile int[] _pids = [];
|
||||
|
||||
public void Follow(GameProcess target)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(target);
|
||||
_pids = target.Pid is { } pinned ? [pinned] : [.. target.Processes.Select(static p => p.Pid)];
|
||||
}
|
||||
|
||||
public bool TryRead([NotNullWhen(true)] out InputReading? reading)
|
||||
{
|
||||
reading = _sum.Take();
|
||||
return reading is not null;
|
||||
}
|
||||
|
||||
public void Add(InputSlice slice, bool paused) =>
|
||||
_sum.Add(slice, inFront: slice.ForegroundProcessId != 0 && Array.IndexOf(_pids, (int)slice.ForegroundProcessId) >= 0, paused);
|
||||
|
||||
public void Dispose() => hub.Close(this);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,98 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
using System.Buffers.Binary;
|
||||
using FrameLedger.Application.Input;
|
||||
|
||||
namespace FrameLedger.Infrastructure.Input;
|
||||
|
||||
/// <summary>
|
||||
/// The bytes <c>GetRawInputBuffer</c> and <c>GetRawInputData</c> fill, walked without a pointer: a run of
|
||||
/// <c>RAWINPUT</c> blocks, each a header and - for a HID device - a count of reports of one size
|
||||
/// (<c>21_INPUT_DEVICES</c> §The reader).
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <para>
|
||||
/// Layout on 64-bit Windows, which is all this project builds for: <c>RAWINPUTHEADER</c> is 24 bytes - <c>u32 type</c>,
|
||||
/// <c>u32 size</c> of the whole block, the device's handle, a parameter - and a <c>RAWHID</c> follows it: <c>u32</c>
|
||||
/// the size of one report, <c>u32</c> how many, then the reports. The next block starts at the next multiple of eight
|
||||
/// (<c>NEXTRAWINPUTBLOCK</c>).
|
||||
/// </para>
|
||||
/// <para>
|
||||
/// <b>It trusts no length it reads.</b> A block that claims more than the buffer holds, or less than its own header,
|
||||
/// ends the walk: what was handed over before it stands, and nothing is read past the buffer. The bytes come from a
|
||||
/// device by way of Windows, into an Agent that may run as administrator.
|
||||
/// </para>
|
||||
/// </remarks>
|
||||
public static class RawInputBuffer
|
||||
{
|
||||
/// <summary><c>sizeof(RAWINPUTHEADER)</c> on 64-bit Windows.</summary>
|
||||
public const int HeaderBytes = 24;
|
||||
|
||||
/// <summary><c>RIM_TYPEHID</c>: the block is a HID device's, the only kind the reader registers for.</summary>
|
||||
public const uint TypeHid = 2;
|
||||
|
||||
private const int _hidHeaderBytes = 8;
|
||||
|
||||
/// <summary>Hands each report of each HID block to <paramref name="sink"/>; returns how many blocks were walked.</summary>
|
||||
/// <param name="buffer">The bytes Windows filled.</param>
|
||||
/// <param name="blocks">How many blocks Windows said it wrote.</param>
|
||||
/// <param name="sink">Told each report with its device's handle.</param>
|
||||
public static int Walk(ReadOnlySpan<byte> buffer, int blocks, IInputBackendSink sink)
|
||||
{
|
||||
ArgumentNullException.ThrowIfNull(sink);
|
||||
int at = 0;
|
||||
int walked = 0;
|
||||
for (; walked < blocks; walked++)
|
||||
{
|
||||
if (buffer.Length - at < HeaderBytes)
|
||||
{
|
||||
break;
|
||||
}
|
||||
|
||||
uint type = BinaryPrimitives.ReadUInt32LittleEndian(buffer[at..]);
|
||||
uint size = BinaryPrimitives.ReadUInt32LittleEndian(buffer[(at + 4)..]);
|
||||
if (size < HeaderBytes || size > buffer.Length - at)
|
||||
{
|
||||
break;
|
||||
}
|
||||
|
||||
if (type == TypeHid)
|
||||
{
|
||||
Reports(buffer.Slice(at, (int)size), sink);
|
||||
}
|
||||
|
||||
// Each block starts on a multiple of eight. The last one may end the buffer without the padding.
|
||||
at += (int)((size + 7) & ~7u);
|
||||
if (at > buffer.Length)
|
||||
{
|
||||
walked++;
|
||||
break;
|
||||
}
|
||||
}
|
||||
|
||||
return walked;
|
||||
}
|
||||
|
||||
private static void Reports(ReadOnlySpan<byte> block, IInputBackendSink sink)
|
||||
{
|
||||
if (block.Length < HeaderBytes + _hidHeaderBytes)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
nint device = (nint)BinaryPrimitives.ReadInt64LittleEndian(block[8..]);
|
||||
uint reportBytes = BinaryPrimitives.ReadUInt32LittleEndian(block[HeaderBytes..]);
|
||||
uint count = BinaryPrimitives.ReadUInt32LittleEndian(block[(HeaderBytes + 4)..]);
|
||||
ReadOnlySpan<byte> reports = block[(HeaderBytes + _hidHeaderBytes)..];
|
||||
if (reportBytes == 0 || count == 0 || (ulong)reportBytes * count > (ulong)reports.Length)
|
||||
{
|
||||
return;
|
||||
}
|
||||
|
||||
for (int i = 0; i < count; i++)
|
||||
{
|
||||
sink.Report(device, reports.Slice(i * (int)reportBytes, (int)reportBytes));
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,259 @@
|
||||
// SPDX-License-Identifier: GPL-3.0-only
|
||||
// Copyright (C) 2026 poli0981 - additional terms under GPLv3 section 7: see NOTICE
|
||||
|
||||
using System.Runtime.InteropServices;
|
||||
|
||||
namespace FrameLedger.Infrastructure.Input;
|
||||
|
||||
/// <summary>
|
||||
/// Every Windows function the input reader calls, declared in one place so that the list can be held
|
||||
/// (<c>tools/input-readonly-check.ps1</c>, <c>21_INPUT_DEVICES</c> §What is read): raw input for game controllers,
|
||||
/// three of XInput's getters, the time of the last input, and the message-only window raw input is delivered to.
|
||||
/// </summary>
|
||||
/// <remarks>
|
||||
/// <b>What is not here is not called.</b> No function that sends anything to a device (<c>XInputSetState</c>, a HID
|
||||
/// output or feature report), none that reads a key or a button of the keyboard or mouse, no hook. The structures are
|
||||
/// declared by hand, blittable, with the sizes the tests assert - the reader passes them to Windows by pointer.
|
||||
/// </remarks>
|
||||
internal static unsafe class Win32Input
|
||||
{
|
||||
public const uint WmInputDeviceChange = 0x00FE;
|
||||
public const uint WmInput = 0x00FF;
|
||||
|
||||
/// <summary><c>GIDC_ARRIVAL</c> / <c>GIDC_REMOVAL</c>: <c>WM_INPUT_DEVICE_CHANGE</c>'s wParam.</summary>
|
||||
public const nuint DeviceArrival = 1;
|
||||
public const nuint DeviceRemoval = 2;
|
||||
|
||||
/// <summary><c>RIDEV_INPUTSINK</c>: reports are delivered while the caller is not in front.</summary>
|
||||
public const uint RidevInputSink = 0x00000100;
|
||||
|
||||
/// <summary><c>RIDEV_DEVNOTIFY</c>: a device arriving or leaving is told.</summary>
|
||||
public const uint RidevDevNotify = 0x00002000;
|
||||
|
||||
/// <summary><c>RIDEV_REMOVE</c>: ends a registration.</summary>
|
||||
public const uint RidevRemove = 0x00000001;
|
||||
|
||||
public const uint RidiDeviceName = 0x20000007;
|
||||
public const uint RidiDeviceInfo = 0x2000000B;
|
||||
|
||||
/// <summary><c>RID_INPUT</c>: <c>GetRawInputData</c> returns the whole block.</summary>
|
||||
public const uint RidInput = 0x10000003;
|
||||
|
||||
public const uint PmRemove = 0x0001;
|
||||
|
||||
/// <summary><c>XINPUT_CAPS_WIRELESS</c>.</summary>
|
||||
public const ushort XInputCapsWireless = 0x0002;
|
||||
|
||||
/// <summary><c>XINPUT_FLAG_GAMEPAD</c>.</summary>
|
||||
public const uint XInputFlagGamepad = 0x00000001;
|
||||
|
||||
/// <summary><c>BATTERY_DEVTYPE_GAMEPAD</c>.</summary>
|
||||
public const byte BatteryDevTypeGamepad = 0x00;
|
||||
|
||||
/// <summary><c>HWND_MESSAGE</c>: the parent of a window that is never shown and receives no broadcast.</summary>
|
||||
public static readonly nint HwndMessage = -3;
|
||||
|
||||
private const string _user32 = "user32.dll";
|
||||
private const string _kernel32 = "kernel32.dll";
|
||||
private const string _xinput = "xinput1_4.dll";
|
||||
|
||||
[DefaultDllImportSearchPaths(DllImportSearchPath.System32)]
|
||||
[DllImport(_user32, ExactSpelling = true, SetLastError = true)]
|
||||
public static extern ushort RegisterClassExW(WndClassEx* windowClass);
|
||||
|
||||
[DefaultDllImportSearchPaths(DllImportSearchPath.System32)]
|
||||
[DllImport(_user32, ExactSpelling = true)]
|
||||
public static extern int UnregisterClassW(char* className, nint instance);
|
||||
|
||||
[DefaultDllImportSearchPaths(DllImportSearchPath.System32)]
|
||||
[DllImport(_user32, ExactSpelling = true, SetLastError = true)]
|
||||
public static extern nint CreateWindowExW(uint exStyle, char* className, char* windowName, uint style, int x, int y, int width, int height, nint parent, nint menu, nint instance, void* param);
|
||||
|
||||
[DefaultDllImportSearchPaths(DllImportSearchPath.System32)]
|
||||
[DllImport(_user32, ExactSpelling = true)]
|
||||
public static extern int DestroyWindow(nint window);
|
||||
|
||||
[DefaultDllImportSearchPaths(DllImportSearchPath.System32)]
|
||||
[DllImport(_user32, ExactSpelling = true)]
|
||||
public static extern nint DefWindowProcW(nint window, uint message, nuint wParam, nint lParam);
|
||||
|
||||
[DefaultDllImportSearchPaths(DllImportSearchPath.System32)]
|
||||
[DllImport(_user32, ExactSpelling = true)]
|
||||
public static extern int PeekMessageW(Message* message, nint window, uint filterMin, uint filterMax, uint remove);
|
||||
|
||||
[DefaultDllImportSearchPaths(DllImportSearchPath.System32)]
|
||||
[DllImport(_user32, ExactSpelling = true)]
|
||||
public static extern nint DispatchMessageW(Message* message);
|
||||
|
||||
[DefaultDllImportSearchPaths(DllImportSearchPath.System32)]
|
||||
[DllImport(_user32, ExactSpelling = true, SetLastError = true)]
|
||||
public static extern int RegisterRawInputDevices(RawInputDevice* devices, uint count, uint size);
|
||||
|
||||
[DefaultDllImportSearchPaths(DllImportSearchPath.System32)]
|
||||
[DllImport(_user32, ExactSpelling = true, SetLastError = true)]
|
||||
public static extern uint GetRawInputBuffer(void* data, uint* size, uint headerSize);
|
||||
|
||||
[DefaultDllImportSearchPaths(DllImportSearchPath.System32)]
|
||||
[DllImport(_user32, ExactSpelling = true, SetLastError = true)]
|
||||
public static extern uint GetRawInputData(nint rawInput, uint command, void* data, uint* size, uint headerSize);
|
||||
|
||||
[DefaultDllImportSearchPaths(DllImportSearchPath.System32)]
|
||||
[DllImport(_user32, ExactSpelling = true, SetLastError = true)]
|
||||
public static extern uint GetRawInputDeviceInfoW(nint device, uint command, void* data, uint* size);
|
||||
|
||||
[DefaultDllImportSearchPaths(DllImportSearchPath.System32)]
|
||||
[DllImport(_user32, ExactSpelling = true, SetLastError = true)]
|
||||
public static extern uint GetRawInputDeviceList(RawInputDeviceListEntry* list, uint* count, uint size);
|
||||
|
||||
[DefaultDllImportSearchPaths(DllImportSearchPath.System32)]
|
||||
[DllImport(_user32, ExactSpelling = true)]
|
||||
public static extern int GetLastInputInfo(LastInputInfo* info);
|
||||
|
||||
[DefaultDllImportSearchPaths(DllImportSearchPath.System32)]
|
||||
[DllImport(_kernel32, ExactSpelling = true)]
|
||||
public static extern nint GetModuleHandleW(char* name);
|
||||
|
||||
[DefaultDllImportSearchPaths(DllImportSearchPath.System32)]
|
||||
[DllImport(_kernel32, ExactSpelling = true)]
|
||||
public static extern nint GetCurrentThread();
|
||||
|
||||
[DefaultDllImportSearchPaths(DllImportSearchPath.System32)]
|
||||
[DllImport(_kernel32, ExactSpelling = true)]
|
||||
public static extern int GetThreadTimes(nint thread, long* creation, long* exit, long* kernel, long* user);
|
||||
|
||||
[DefaultDllImportSearchPaths(DllImportSearchPath.System32)]
|
||||
[DllImport(_xinput, ExactSpelling = true)]
|
||||
public static extern uint XInputGetState(uint userIndex, XInputState* state);
|
||||
|
||||
[DefaultDllImportSearchPaths(DllImportSearchPath.System32)]
|
||||
[DllImport(_xinput, ExactSpelling = true)]
|
||||
public static extern uint XInputGetCapabilities(uint userIndex, uint flags, XInputCapabilities* capabilities);
|
||||
|
||||
[DefaultDllImportSearchPaths(DllImportSearchPath.System32)]
|
||||
[DllImport(_xinput, ExactSpelling = true)]
|
||||
public static extern uint XInputGetBatteryInformation(uint userIndex, byte deviceType, XInputBatteryInformation* battery);
|
||||
|
||||
/// <summary><c>WNDCLASSEXW</c>.</summary>
|
||||
[StructLayout(LayoutKind.Sequential)]
|
||||
public struct WndClassEx
|
||||
{
|
||||
public uint Size;
|
||||
public uint Style;
|
||||
public delegate* unmanaged[Stdcall]<nint, uint, nuint, nint, nint> WndProc;
|
||||
public int ClassExtra;
|
||||
public int WindowExtra;
|
||||
public nint Instance;
|
||||
public nint Icon;
|
||||
public nint Cursor;
|
||||
public nint Background;
|
||||
public char* MenuName;
|
||||
public char* ClassName;
|
||||
public nint SmallIcon;
|
||||
}
|
||||
|
||||
/// <summary><c>MSG</c>.</summary>
|
||||
[StructLayout(LayoutKind.Sequential)]
|
||||
public struct Message
|
||||
{
|
||||
public nint Window;
|
||||
public uint Id;
|
||||
public nuint WParam;
|
||||
public nint LParam;
|
||||
public uint Time;
|
||||
public int X;
|
||||
public int Y;
|
||||
}
|
||||
|
||||
/// <summary><c>RAWINPUTDEVICE</c>.</summary>
|
||||
[StructLayout(LayoutKind.Sequential)]
|
||||
public struct RawInputDevice
|
||||
{
|
||||
public ushort UsagePage;
|
||||
public ushort Usage;
|
||||
public uint Flags;
|
||||
public nint Target;
|
||||
}
|
||||
|
||||
/// <summary><c>RAWINPUTDEVICELIST</c>.</summary>
|
||||
[StructLayout(LayoutKind.Sequential)]
|
||||
public struct RawInputDeviceListEntry
|
||||
{
|
||||
public nint Device;
|
||||
public uint Type;
|
||||
}
|
||||
|
||||
/// <summary><c>RID_DEVICE_INFO</c>, with the HID member of its union - the only one the reader looks at.</summary>
|
||||
[StructLayout(LayoutKind.Explicit, Size = 32)]
|
||||
public struct RidDeviceInfo
|
||||
{
|
||||
[FieldOffset(0)]
|
||||
public uint Size;
|
||||
|
||||
[FieldOffset(4)]
|
||||
public uint Type;
|
||||
|
||||
[FieldOffset(8)]
|
||||
public uint VendorId;
|
||||
|
||||
[FieldOffset(12)]
|
||||
public uint ProductId;
|
||||
|
||||
[FieldOffset(16)]
|
||||
public uint VersionNumber;
|
||||
|
||||
[FieldOffset(20)]
|
||||
public ushort UsagePage;
|
||||
|
||||
[FieldOffset(22)]
|
||||
public ushort Usage;
|
||||
}
|
||||
|
||||
/// <summary><c>XINPUT_GAMEPAD</c>.</summary>
|
||||
[StructLayout(LayoutKind.Sequential)]
|
||||
public struct XInputGamepad
|
||||
{
|
||||
public ushort Buttons;
|
||||
public byte LeftTrigger;
|
||||
public byte RightTrigger;
|
||||
public short ThumbLx;
|
||||
public short ThumbLy;
|
||||
public short ThumbRx;
|
||||
public short ThumbRy;
|
||||
}
|
||||
|
||||
/// <summary><c>XINPUT_STATE</c>.</summary>
|
||||
[StructLayout(LayoutKind.Sequential)]
|
||||
public struct XInputState
|
||||
{
|
||||
public uint PacketNumber;
|
||||
public XInputGamepad Gamepad;
|
||||
}
|
||||
|
||||
/// <summary><c>XINPUT_CAPABILITIES</c>.</summary>
|
||||
[StructLayout(LayoutKind.Sequential)]
|
||||
public struct XInputCapabilities
|
||||
{
|
||||
public byte Type;
|
||||
public byte SubType;
|
||||
public ushort Flags;
|
||||
public XInputGamepad Gamepad;
|
||||
public ushort LeftMotor;
|
||||
public ushort RightMotor;
|
||||
}
|
||||
|
||||
/// <summary><c>XINPUT_BATTERY_INFORMATION</c>.</summary>
|
||||
[StructLayout(LayoutKind.Sequential)]
|
||||
public struct XInputBatteryInformation
|
||||
{
|
||||
public byte Type;
|
||||
public byte Level;
|
||||
}
|
||||
|
||||
/// <summary><c>LASTINPUTINFO</c>.</summary>
|
||||
[StructLayout(LayoutKind.Sequential)]
|
||||
public struct LastInputInfo
|
||||
{
|
||||
public uint Size;
|
||||
public uint Time;
|
||||
}
|
||||
}
|
||||
Loaded 100 of 175 files, more files were not shown because too many files have changed in this diff.
Show more
Reference in new issue
Block a user