WIP: fix(input): custom ocarina note buttons count with the controller in the background #1168

Draft
TrashPanda wants to merge 1 commit from TrashPanda/Longshot:fix/background-ocarina-remaps into main
Contributor

Type: fix · Risk: low · Tested on: Linux, RTX 4070 Ti (game-free checks) · Needs: Windows, any GPU

Why

With "Controller in background" on, the controller works behind another window, except the ocarina notes bound to custom buttons: those were dropped, so the ocarina could not be played that way.

Restored from Hookshot 2944, by jarynclouatre, and split out of #286 so it can be reviewed and merged on its own.

How to reproduce

Seen on: any OS, a controller
Settings and switches: Controller in background on; an ocarina note bound to a custom button
Steps: put another window in front and play that note on the controller
Expected: the note plays
Actual: nothing plays

What changed

oc_pad_word gives the remapped notes in the background when the pads count there, by the same rule read_input uses (pads_behind). The keyboard's note keys still count only with the window in front.

Commits, each with its original author and message:

428c40cd fix(input): custom ocarina note buttons count with the controller in the background (jarynclouatre)

With "controller in the background" on (HOS_INPUT_BACKGROUND=1 or the
menu's row), the pads reach the game behind another window, but an
ocarina note bound to a custom pad button did not: oc_pad_word
returned the game's word unchanged whenever the window was not in front,
so the remapped notes were dropped while the rest of the pad worked.

  • oc_pad_word gives the notes in the background when the pads count
    there, by the same rule read_input uses (pads_in_background on the
    switch, else the menu's row), through a small pads_behind helper.

  • oc_notes takes the keyboard's note keys only with the window in
    front, so a key held in another program never plays a note. The pads'
    note buttons count in both cases.

  • tests/test_ocarina_notes.py, new case: with the pads counting in the
    background, a pad's note button plays its note and the keyboard's note
    key does not; without the row the word is unchanged. It fails on main
    (oc_pad_word(0) gives no L), and passes here.

  • tests/test_input_background.py: its fixture takes the new helper.

  • Full suite on Linux: 442 passed, 85 skipped, 1 failed
    (test_bake_portability: zstandard is not installed on this machine;
    it fails the same on main).

  • Not tested in the game.

Restored-from: https://github.com/NotRexed/Hookshot/pull/2944

Measurements

Verdict: nothing to measure: a correctness fix off the frame path, covered by game-free checks.

Flags and settings

None.

Testing

Tested: On Linux (kernel 7.0), RTX 4070 Ti, main @ 71b1edd8, this PR @ 428c40cd: tests/test_ocarina_notes.py, tests/test_input_background.py pass. The full suite (tests/run_all.py) has not been run on this branch yet; a comment will follow when it has.

Not tested: Playing the ocarina in the game behind another window. Opened as work in progress until it runs in the game.

Must be tested:

  • Any OS, a controller (by hand): the steps under How to reproduce, expecting the note to play, and a keyboard note key held in the other window not to

Risks

What could break: ocarina input with the window in the background.

Turning it off: revert the commit.

Compatibility: Nothing changes.

Checklist

Everyone

  • One topic.
  • The title is a Conventional Commit (type(scope): description) of the status line's type.
  • Why gives the reason plainly and links the issues that fit (the tracker searched).
  • Tested on my own PC where it runs (in the game, for a change the game runs), as Testing's Tested says; what
    can't be run by hand is in Testing's Not testable by hand, with why.
  • Measurements has a verdict, or one line saying why there is nothing to measure.
  • Nothing gets worse that I know of: any cost (speed, latency, memory, a setup that worked before) is measured and
    in Risks.
  • Testing names what was tested, what wasn't, and what must still be tested, where and how.
  • Rebased on current main.
  • No game files, dumps, build output or generated files.
  • third_party/ untouched (a new folder with a PROVENANCE.md instead).
  • The license is OK: GPL-3.0-or-later, nothing incompatible and nothing decompiled.
  • python -I -B tests/run_all.py passes (any failure that also fails on main is named).

When it applies

  • A game-free test added for the fix, failing on main and passing here.
**Type:** fix · **Risk:** low · **Tested on:** Linux, RTX 4070 Ti (game-free checks) · **Needs:** Windows, any GPU ## Why With "Controller in background" on, the controller works behind another window, except the ocarina notes bound to custom buttons: those were dropped, so the ocarina could not be played that way. Restored from [Hookshot 2944](https://github.com/NotRexed/Hookshot/pull/2944), by jarynclouatre, and split out of [#286](https://git.magicbean.dev/MagicBeanDev/Longshot/pulls/286) so it can be reviewed and merged on its own. ## How to reproduce **Seen on:** any OS, a controller **Settings and switches:** Controller in background on; an ocarina note bound to a custom button **Steps:** put another window in front and play that note on the controller **Expected:** the note plays **Actual:** nothing plays ## What changed `oc_pad_word` gives the remapped notes in the background when the pads count there, by the same rule `read_input` uses (`pads_behind`). The keyboard's note keys still count only with the window in front. Commits, each with its original author and message: <details><summary><code>428c40cd</code> fix(input): custom ocarina note buttons count with the controller in the background (jarynclouatre)</summary> With "controller in the background" on (`HOS_INPUT_BACKGROUND=1` or the menu's row), the pads reach the game behind another window, but an ocarina note bound to a custom pad button did not: `oc_pad_word` returned the game's word unchanged whenever the window was not in front, so the remapped notes were dropped while the rest of the pad worked. - `oc_pad_word` gives the notes in the background when the pads count there, by the same rule `read_input` uses (`pads_in_background` on the switch, else the menu's row), through a small `pads_behind` helper. - `oc_notes` takes the keyboard's note keys only with the window in front, so a key held in another program never plays a note. The pads' note buttons count in both cases. - `tests/test_ocarina_notes.py`, new case: with the pads counting in the background, a pad's note button plays its note and the keyboard's note key does not; without the row the word is unchanged. It fails on main (`oc_pad_word(0)` gives no L), and passes here. - `tests/test_input_background.py`: its fixture takes the new helper. - Full suite on Linux: 442 passed, 85 skipped, 1 failed (`test_bake_portability`: `zstandard` is not installed on this machine; it fails the same on main). - Not tested in the game. Restored-from: https://github.com/NotRexed/Hookshot/pull/2944 </details> ## Measurements **Verdict:** nothing to measure: a correctness fix off the frame path, covered by game-free checks. ### Flags and settings None. ## Testing **Tested:** On Linux (kernel 7.0), RTX 4070 Ti, `main` @ 71b1edd8, this PR @ 428c40cd: `tests/test_ocarina_notes.py`, `tests/test_input_background.py` pass. The full suite (`tests/run_all.py`) has not been run on this branch yet; a comment will follow when it has. **Not tested:** Playing the ocarina in the game behind another window. Opened as work in progress until it runs in the game. **Must be tested:** - Any OS, a controller (by hand): the steps under How to reproduce, expecting the note to play, and a keyboard note key held in the other window not to ## Risks **What could break:** ocarina input with the window in the background. **Turning it off:** revert the commit. **Compatibility:** Nothing changes. ## Checklist ### Everyone - [x] One topic. - [x] The title is a Conventional Commit (`type(scope): description`) of the status line's type. - [x] Why gives the reason plainly and links the issues that fit (the tracker searched). - [x] Tested on my own PC where it runs (in the game, for a change the game runs), as Testing's Tested says; what can't be run by hand is in Testing's Not testable by hand, with why. - [x] Measurements has a verdict, or one line saying why there is nothing to measure. - [x] Nothing gets worse that I know of: any cost (speed, latency, memory, a setup that worked before) is measured and in Risks. - [x] Testing names what was tested, what wasn't, and what must still be tested, where and how. - [x] Rebased on current `main`. - [x] No game files, dumps, build output or generated files. - [x] `third_party/` untouched (a new folder with a `PROVENANCE.md` instead). - [x] The license is OK: GPL-3.0-or-later, nothing incompatible and nothing decompiled. - [ ] `python -I -B tests/run_all.py` passes (any failure that also fails on `main` is named). ### When it applies - [x] A game-free test added for the fix, failing on `main` and passing here.
fix(input): custom ocarina note buttons count with the controller in the background
Some checks are pending
CI / Conventional Commit title (pull_request) Blocked by required conditions
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Blocked by required conditions
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Blocked by required conditions
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Blocked by required conditions
CI / Workflow lint (actionlint) (pull_request) Blocked by required conditions
Guide screenshots / Guide images and local UI source review (pull_request) Blocked by required conditions
Third-party parts / As their notes say (pull_request) Blocked by required conditions
Third-party parts / The same as upstream (pull_request) Blocked by required conditions
Website / Website on Cloudflare (pull_request_target) Has been skipped
PR description / Description follows the template (pull_request_target) Successful in 8s
428c40cd27
With "controller in the background" on (`HOS_INPUT_BACKGROUND=1` or the
menu's row), the pads reach the game behind another window, but an
ocarina note bound to a custom pad button did not: `oc_pad_word`
returned the game's word unchanged whenever the window was not in front,
so the remapped notes were dropped while the rest of the pad worked.

- `oc_pad_word` gives the notes in the background when the pads count
there, by the same rule `read_input` uses (`pads_in_background` on the
switch, else the menu's row), through a small `pads_behind` helper.
- `oc_notes` takes the keyboard's note keys only with the window in
front, so a key held in another program never plays a note. The pads'
note buttons count in both cases.

- `tests/test_ocarina_notes.py`, new case: with the pads counting in the
background, a pad's note button plays its note and the keyboard's note
key does not; without the row the word is unchanged. It fails on main
(`oc_pad_word(0)` gives no L), and passes here.
- `tests/test_input_background.py`: its fixture takes the new helper.
- Full suite on Linux: 442 passed, 85 skipped, 1 failed
(`test_bake_portability`: `zstandard` is not installed on this machine;
it fails the same on main).
- Not tested in the game.

Restored-from: https://github.com/NotRexed/Hookshot/pull/2944
Author
Contributor

Tested in game: Linux (Ubuntu 26.04.1, kernel 7.0.0-43), RTX 4070 Ti 12 GB, NVIDIA 595.99.02, Ryzen 7 9800X3D: this branch built together with the other 18 split from #218 and #284-#288, merged onto main @ 71b1edd8 (make_game.py --update, build v3.0.0-rc.5-82-g5952bb3d), then played by a scripted tour through the control bridge (scripts/memtour.py: a save loaded, Zora's Domain, the Market, Hyrule Field and Death Mountain Trail, 40 s each with walking and camera swings). All 4 stops reached, a clean quit, and no device loss or Vulkan error in the log. Only scripted input ran; no controller was connected and the game was not put in the background, so the ocarina remaps in the background were not tried by hand.

Tested in game: Linux (Ubuntu 26.04.1, kernel 7.0.0-43), RTX 4070 Ti 12 GB, NVIDIA 595.99.02, Ryzen 7 9800X3D: this branch built together with the other 18 split from #218 and #284-#288, merged onto main @ 71b1edd8 (make_game.py --update, build v3.0.0-rc.5-82-g5952bb3d), then played by a scripted tour through the control bridge (scripts/memtour.py: a save loaded, Zora's Domain, the Market, Hyrule Field and Death Mountain Trail, 40 s each with walking and camera swings). All 4 stops reached, a clean quit, and no device loss or Vulkan error in the log. Only scripted input ran; no controller was connected and the game was not put in the background, so the ocarina remaps in the background were not tried by hand.
Author
Contributor

This and #1169 both change tests/test_input_background.py (the functions the check cuts from host/nn_hid.c). Whichever merges second needs a one-line rebase there: cut pads_in_background, pads_behind and pads_merge, in that order. Both were built and run together that way (see the first comment).

This and #1169 both change `tests/test_input_background.py` (the functions the check cuts from `host/nn_hid.c`). Whichever merges second needs a one-line rebase there: cut `pads_in_background`, `pads_behind` and `pads_merge`, in that order. Both were built and run together that way (see the first comment).
Owner

Brought up to the ready-for-review standard (#1454): the checklist's Everyone list has two new boxes, added here from what this PR's description and comments show (please check they match what you know).

  • Tested on my own PC: ticked: Author's Tested in game comments describe an in-game run on Linux with an RTX 4070 Ti, though the background controller remaps were not tried by hand.
  • Nothing gets worse that I know of: ticked: Measurements gives a verdict of nothing to measure for a correctness fix, and Risks names no slower, latency or memory cost.
Brought up to the [ready-for-review standard](https://git.magicbean.dev/MagicBeanDev/Longshot/src/branch/main/CONTRIBUTING.md#ready-for-review-out-of-wip) (#1454): the checklist's Everyone list has two new boxes, added here from what this PR's description and comments show (please check they match what you know). - *Tested on my own PC*: ticked: Author's Tested in game comments describe an in-game run on Linux with an RTX 4070 Ti, though the background controller remaps were not tried by hand. - *Nothing gets worse that I know of*: ticked: Measurements gives a verdict of nothing to measure for a correctness fix, and Risks names no slower, latency or memory cost.
Some checks are pending
CI / Conventional Commit title (pull_request) Blocked by required conditions
CI / Python source checks (ubuntu-24.04, part 1/2) (pull_request) Blocked by required conditions
CI / Python source checks (ubuntu-24.04, part 2/2) (pull_request) Blocked by required conditions
CI / SPIR-V fixtures (global narrow load/store, direct surface atomics, F2I immediate) (pull_request) Blocked by required conditions
CI / Workflow lint (actionlint) (pull_request) Blocked by required conditions
Guide screenshots / Guide images and local UI source review (pull_request) Blocked by required conditions
Third-party parts / As their notes say (pull_request) Blocked by required conditions
Third-party parts / The same as upstream (pull_request) Blocked by required conditions
Website / Website on Cloudflare (pull_request_target) Has been skipped
PR description / Description follows the template (pull_request_target) Successful in 8s
This pull request is marked as a work in progress.
Some workflows are waiting to be reviewed.
This branch is out-of-date with the base branch
View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.
git fetch -u 'fix/background-ocarina-remaps:TrashPanda-fix/background-ocarina-remaps'
git switch 'TrashPanda-fix/background-ocarina-remaps'
Sign in to join this conversation.
No reviewers
No milestone
No project
No assignees
2 participants
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference
MagicBeanDev/Longshot!1168
No description provided.