From 8d91667c28ba542d32d9cf6e9bfb31d0704d57e0 Mon Sep 17 00:00:00 2001 From: epicmeme546 <178368684+epicmeme546@users.noreply.github.com> Date: Tue, 10 Nov 2026 00:44:36 -0500 Subject: [PATCH] Keep only the game's select and back sounds in the launcher, and make none of its own. The cursor's sound played at every move of the pointer and cut the other two short, as one sound plays at a time: it is gone, and moving the cursor is silent. A choice, a changed switch, Play and the end of a build play the game's decide sound; going back and a failure play its cancel sound. The chimes the launcher made from sine tones are removed too, so every sound it plays is decoded from the player's own game into data/cache/sounds and it is silent until the game has been read. No sound file is in the repository, the release or the setup. Co-Authored-By: Claude Fable 5.2 --- docs/launcher.md | 14 ++--- docs/releases/v0.6.2.md | 2 +- launcher/gamefiles.py | 5 +- launcher/ui/app.py | 27 +++++----- launcher/ui/sound.py | 93 +++++++-------------------------- tests/launcher_test.py | 111 ++++++++++++++++++---------------------- 6 files changed, 89 insertions(+), 163 deletions(-) diff --git a/docs/launcher.md b/docs/launcher.md index b2f9c72d..33c04bd1 100644 --- a/docs/launcher.md +++ b/docs/launcher.md @@ -47,13 +47,13 @@ Customize Launcher (on the home screen) makes the look the player's own: - Animations (on by default): the cursor glides from row to row, a new screen slides into place, sparks drift up over the backdrop and Navi bobs in the title band with a pulsing halo (`App.animate`). They move by the time that passed, stand still while the window is hidden or minimised, and Off stops them all. -- Sounds (off by default; Low, Medium or High): the game's own interface sounds, the cursor, decide and cancel - sounds of its menus, when the cursor moves or a choice changes, a row is chosen and the player goes back. The - launcher decodes them from the player's built game or dump into `data/cache/sounds` (`gamefiles.extract_sounds`: - `Sound/Resource/Stream/SE_Sys_Cursor00.bwav`, `SE_Sys_Do00.bwav` and `SE_Sys_Cancel00.bwav`, the files - `runtime/menu_sound.c` plays in the in-game menu), so no sound ships; until they are decoded, chimes made from sine - tones in `launcher/ui/sound.py` stand in. They are played from memory (PlaySound on Windows; `pw-play`, `paplay` - or `aplay` elsewhere). +- Sounds (off by default; Low, Medium or High): two of the game's own interface sounds, the decide and cancel sounds + of its menus, when a row is chosen or a choice changes and when the player goes back. The launcher decodes them + from the player's built game or dump into `data/cache/sounds` (`gamefiles.extract_sounds`: + `Sound/Resource/Stream/SE_Sys_Do00.bwav` and `SE_Sys_Cancel00.bwav`, the files `runtime/menu_sound.c` plays in the + in-game menu). No sound is in the repository, the release or the setup, and the launcher makes none of its own: + it is silent until the player's game has been read. Moving the cursor makes no sound. They are played from memory + (PlaySound on Windows; `pw-play`, `paplay` or `aplay` elsewhere). The choices are `theme`, `background`, `background_dim`, `animations` and `sounds` in `data/launcher.json`. diff --git a/docs/releases/v0.6.2.md b/docs/releases/v0.6.2.md index 28ab3581..2e96eae0 100644 --- a/docs/releases/v0.6.2.md +++ b/docs/releases/v0.6.2.md @@ -9,7 +9,7 @@ Draft notes for the release after 0.6.1. The version number is not decided yet. it takes effect at the next start. - Customize Launcher (on the launcher's home screen): six colour schemes, a background picture of your own with adjustable dimming, animations (a gliding cursor, sliding screens, drifting sparks) and sound effects: the game's - own cursor, select and back sounds, read from your game. The sounds are off until you turn them on. + own select and back sounds, read from your game. The sounds are off until you turn them on. - Three more settings take effect without a restart: HDR between off and the tone mapper (only the game's native HDR still waits for one), the camera's stick sensitivity, and the speakers (stereo or 5.1). diff --git a/launcher/gamefiles.py b/launcher/gamefiles.py index 5147a01b..bf3998a0 100644 --- a/launcher/gamefiles.py +++ b/launcher/gamefiles.py @@ -27,7 +27,6 @@ FONTS = { # role -> RomFS path; the window sets all its text in Cetra Display 'title': 'Font2/Scalable/CetraDisplayPro-Medium.Nin_Ounce_NVN2.bfotf.zs', } SOUNDS = { # the window's sound effect (launcher/ui/sound.py) -> the game's interface sound - 'move': 'Sound/Resource/Stream/SE_Sys_Cursor00.bwav', 'select': 'Sound/Resource/Stream/SE_Sys_Do00.bwav', 'back': 'Sound/Resource/Stream/SE_Sys_Cancel00.bwav', } @@ -398,8 +397,8 @@ def cached_sounds(layout): def extract_sounds(layout, game_dir='', dump=''): - """Decode the game's cursor, select and back sounds into data/cache/sounds as WAV files; {effect: path} of the - ones found.""" + """Decode the game's select and back sounds into data/cache/sounds as WAV files; {effect: path} of the ones + found.""" romfs = open_romfs(layout, game_dir, dump) if romfs is None: return {} diff --git a/launcher/ui/app.py b/launcher/ui/app.py index 39035e8a..a1ecb8ff 100644 --- a/launcher/ui/app.py +++ b/launcher/ui/app.py @@ -21,7 +21,7 @@ Mouse, keyboard (arrows, Enter or Space, Esc, F5) and an XInput gamepad (d-pad o The look is the player's (Customize Launcher): art.set_theme fills the palette every picture is drawn from, a picture of the player's own can replace the backdrop (picture.py), and unless Animations is off the cursor glides between rows, a new screen slides in, sparks drift over the backdrop and Navi bobs in the title band (animate). sound.py -plays a short chime for a move, a change, a choice and the end of a job. +plays the game's own decide and cancel sounds, read from the player's game, for a choice and for going back. """ import argparse import math @@ -482,10 +482,7 @@ class App: if not idx: return pos = idx.index(self.focus) if self.focus in idx else 0 - was = self.focus self.focus = idx[max(0, min(len(idx) - 1, pos + d))] - if self.focus != was: - self.sounds.play('move') self.render() def focused(self): @@ -503,7 +500,8 @@ class App: r.pick = max(0, min(len(r.actions) - 1, getattr(r, 'pick', 0) + d)) else: return - self.sounds.play('move' if r.kind == 'pair' else 'toggle') + if r.kind != 'pair': # a switch or a choice changed + self.sounds.play('select') self.render() def activate(self): @@ -511,10 +509,10 @@ class App: if not r or not r.enabled: return if r.kind == 'toggle': - self.sounds.play('toggle') + self.sounds.play('select') r.on(not r.get()) elif r.kind == 'enum': - self.sounds.play('toggle') + self.sounds.play('select') r.right() elif r.kind == 'pair': self.sounds.play('select') @@ -572,7 +570,6 @@ class App: r = self.rows[i] if r.kind == 'pair': r.pick = 0 if e.x < (r.rect[0] + r.rect[2]) / 2 else 1 - self.sounds.play('move') self.render() elif i is not None and self.rows[i].kind == 'pair': r = self.rows[i] @@ -608,12 +605,12 @@ class App: return if r.kind == 'toggle' and r.value_rect: x0, _, x1, _ = r.value_rect - self.sounds.play('toggle') + self.sounds.play('select') r.on(e.x < (x0 + x1) / 2) self.render() elif r.kind == 'enum' and r.value_rect: x0, _, x1, _ = r.value_rect - self.sounds.play('toggle') + self.sounds.play('select') (r.left if e.x < x0 + (x1 - x0) / 3 else r.right)() self.render() elif r.kind == 'pair': @@ -925,7 +922,7 @@ class App: self.settings['sounds'] = keys[max(0, min(len(keys) - 1, at + d))] self.settings.save() self.sounds.set_level(self.settings['sounds']) - self.sounds.play('toggle') # the new loudness, heard at once + self.sounds.play('select') # the new loudness, heard at once bg_desc = ('Use a picture of your own as the background.',) if self.look_message: @@ -951,7 +948,7 @@ class App: desc=('A gliding cursor, sliding screens and drifting sparks.',)), Row('enum', 'Sounds', get=lambda: dict(SOUND_LEVELS).get(self.settings.get('sounds'), 'Off'), left=lambda: sounds(-1), right=lambda: sounds(1), - desc=('The game\'s cursor, select and back sounds. Off by default.',)), + desc=('The game\'s select and back sounds. Off by default.',)), Row('divider'), Row('action', 'Back', on=lambda: self.show('home', self.home_row('Customize Launcher')), height=40, desc=('Back to the main menu.',)), @@ -973,7 +970,7 @@ class App: self.ctx.log(f'background: {path}: {e!r}') self.look_message = str(e) if isinstance(e, picture.PictureError) else \ f'{Path(path).name} could not be used as the background: {e}' - self.sounds.play('error') + self.sounds.play('back') self.show('customize', self.focus) return self.look_message = '' @@ -1224,7 +1221,7 @@ class App: self.render() return self.ctx.log(f'play: {exe}') - self.sounds.play('start') + self.sounds.play('select') if self.settings.get('hide_while_playing'): self.root.withdraw() self.root.after(1000, self.watch_game) @@ -1502,7 +1499,7 @@ class App: winsys.keep_awake(False) self.ctx.log(f'job {j.kind}: {j.result} {j.error}') if j.result in ('ok', 'failed'): - self.sounds.play('done' if j.result == 'ok' else 'error') + self.sounds.play('select' if j.result == 'ok' else 'back') if j.result == 'ok': if j.after == 'restart': if winsys.restart(self.layout, ['--continue-update', versions.display(self.layout.version)]): diff --git a/launcher/ui/sound.py b/launcher/ui/sound.py index 32047832..f49b7d52 100644 --- a/launcher/ui/sound.py +++ b/launcher/ui/sound.py @@ -1,77 +1,31 @@ -"""The launcher's sound effects: the game's own interface sounds, the ones its menus make for the cursor, a choice -and going back, read from the player's game (launcher/gamefiles.py extract_sounds decodes them into -data/cache/sounds, as runtime/menu_sound.c plays them in the in-game menu). No sound file ships: until the player's -game has been read, and for a sound it does not hold, short chimes made here from sine tones stand in. +"""The launcher's sound effects: two of the game's own interface sounds, the ones its menus make for a choice and for +going back, read from the player's game (launcher/gamefiles.py extract_sounds decodes them into data/cache/sounds, as +runtime/menu_sound.c plays them in the in-game menu). No sound ships with the launcher and none is made here: until +the player's game has been read, and for a sound it does not hold, the launcher is silent. -They are off until the player picks a loudness in Customize Launcher (the Sounds row). An effect is a 16-bit WAV in -memory: the game's sound scaled to the loudness (the cursor's a little under the others, as in the game's menu), or a -few plucked notes (a tone with two overtones, a quick attack and an exponential decay). Windows plays it with -PlaySound from that memory; elsewhere the WAV goes to a file in the cache folder and the first of pw-play, paplay -and aplay found plays it. One effect sounds at a time: a new one cuts the last, so the cursor's sound is left out -for a quarter of a second after a choice, which the pointer landing on a row of the next screen would otherwise cut. +They are off until the player picks a loudness in Customize Launcher (the Sounds row). An effect is the game's sound +as a 16-bit WAV in memory, scaled to the loudness. Windows plays it with PlaySound from that memory; elsewhere the WAV +goes to a file in the cache folder and the first of pw-play, paplay and aplay found plays it. One effect sounds at a +time: a new one cuts the last. Moving the cursor makes no sound, as it would cut a choice's sound short every time +the pointer lands on a row of the next screen. - move the cursor went to another row the game's cursor sound - toggle a switch or a choice changed the cursor sound - select a row was chosen (another screen) the game's decide sound - back back to the screen before the game's cancel sound - start Play the decide sound - done an install, update or rebuild finished the decide sound - error something could not be done the cancel sound + select a row was chosen, a switch or a choice changed, Play, the end of a build the game's decide sound + back back to the screen before, something could not be done the game's cancel sound """ import ctypes import os import shutil import struct import subprocess -import time import numpy as np -RATE = 44100 LEVELS = {'off': 0.0, 'low': 0.18, 'medium': 0.4, 'high': 0.75} # the Sounds choice: the loudest sample's share of full scale -# Which of the game's sounds (gamefiles.SOUNDS) each effect plays, and how loud beside the others. -GAME_SOUND = {'move': ('move', 0.6), 'toggle': ('move', 0.6), 'select': ('select', 1.0), 'start': ('select', 1.0), - 'done': ('select', 1.0), 'back': ('back', 1.0), 'error': ('back', 1.0)} -QUIET_AFTER = 0.25 # seconds after a choice in which the cursor's sound is left out - -# Notes as (start in seconds, frequency in Hz, length in seconds, loudness 0..1). -C5, D5, E5, G5, A5, C6, D6, E6, G6, C7 = 523.25, 587.33, 659.25, 783.99, 880.0, 1046.5, 1174.66, 1318.51, 1567.98, 2093.0 -EFFECTS = { - 'move': [(0, E6, 0.07, 0.55)], - 'toggle': [(0, G5, 0.10, 0.8), (0.035, D6, 0.10, 0.5)], - 'select': [(0, C6, 0.12, 0.8), (0.07, G6, 0.20, 0.8)], - 'back': [(0, G5, 0.12, 0.8), (0.07, C5, 0.20, 0.7)], - 'start': [(0, C6, 0.14, 0.7), (0.08, E6, 0.14, 0.7), (0.16, G6, 0.14, 0.7), (0.24, C7, 0.45, 0.8)], - 'done': [(0, G5, 0.16, 0.8), (0.12, C6, 0.16, 0.8), (0.24, E6, 0.16, 0.8), (0.36, G6, 0.5, 0.9)], - 'error': [(0, 220.0, 0.16, 0.9), (0.14, 174.61, 0.3, 0.9)], -} +EFFECTS = ('select', 'back') # the names play takes: the game's sounds of gamefiles.SOUNDS -def pluck(freq, length, loudness): - """One note: the tone and two quieter overtones, in within 4 ms and dying away over its length.""" - n = int(RATE * length) - t = np.arange(n, dtype=np.float32) / RATE - wave = np.sin(2 * np.pi * freq * t) + 0.35 * np.sin(2 * np.pi * 2 * freq * t) + 0.12 * np.sin(2 * np.pi * 3 * freq * t) - env = np.minimum(t / 0.004, 1) * np.exp(-t * 5.5 / length) - tail = np.minimum((length - t) / 0.01, 1) # the last 10 ms go to nothing, so the end does not click - return wave * env * tail * loudness - - -def synth(name): - """The effect's samples in -1..1, its loudest at 1.""" - notes = EFFECTS[name] - total = int(RATE * max(start + length for start, _f, length, _l in notes)) + 1 - out = np.zeros(total, dtype=np.float32) - for start, freq, length, loudness in notes: - note = pluck(freq, length, loudness) - at = int(RATE * start) - out[at:at + len(note)] += note - peak = float(np.abs(out).max()) - return out / peak if peak > 0 else out - - -def wav_bytes(samples, level, rate=RATE, channels=1): - """A 16-bit WAV of samples (-1..1; frames by channels when there are two) at level (0..1 of full scale).""" +def wav_bytes(samples, level, rate, channels): + """A 16-bit WAV of samples (-1..1, interleaved when there are two channels) at level (0..1 of full scale).""" pcm = (np.clip(samples * level, -1, 1) * 32767).astype(' (rate, channels, samples) - self.last_choice = 0.0 # when a sound other than the cursor's last started self.wavs = {} # name -> WAV bytes at the current level (Windows plays from this memory: it must stay) self.files = {} # name -> the WAV file elsewhere self.player = None # elsewhere: the program that plays a WAV file @@ -122,7 +75,7 @@ class Sounds: def load_game(self): """Takes up the game's sounds decoded into /sounds (again after gamefiles.extract_sounds wrote them).""" game = {} - for name in {g for g, _gain in GAME_SOUND.values()}: + for name in EFFECTS: try: got = read_wav((self.cache / 'sounds' / f'{name}.wav').read_bytes()) except OSError: @@ -144,12 +97,8 @@ class Sounds: def wav(self, name): if name not in self.wavs: - source, gain = GAME_SOUND[name] - if source in self.game: - rate, channels, samples = self.game[source] - self.wavs[name] = wav_bytes(samples, LEVELS[self.level] * gain, rate, channels) - else: - self.wavs[name] = wav_bytes(synth(name), LEVELS[self.level]) + rate, channels, samples = self.game[name] + self.wavs[name] = wav_bytes(samples, LEVELS[self.level], rate, channels) return self.wavs[name] def stop(self): @@ -161,14 +110,8 @@ class Sounds: pass def play(self, name): - if LEVELS.get(self.level, 0) <= 0 or self.failed or name not in EFFECTS: + if LEVELS.get(self.level, 0) <= 0 or self.failed or name not in self.game: return - now = time.monotonic() - if GAME_SOUND[name][0] == 'move': - if now - self.last_choice < QUIET_AFTER: - return - else: - self.last_choice = now try: if self.winmm: # SND_ASYNC | SND_NODEFAULT | SND_MEMORY: PlaySound reads the bytes while it plays, and self.wavs diff --git a/tests/launcher_test.py b/tests/launcher_test.py index 4735feb5..9db77f43 100644 --- a/tests/launcher_test.py +++ b/tests/launcher_test.py @@ -19,7 +19,7 @@ Run: python tests/launcher_test.py (Python 3.14 for the zstd tests; the window step with the system's C compiler, and its windres call under folders with spaces (a script in windres's place) - jobs: an install driven by a fake make_game.py, with and without the prompts row - the look: the colour schemes, the background picture's fitting and kept copy, the sound effects (off by default, - the game's own interface sounds decoded from a made-up .bwav) + only the game's own select and back sounds, decoded from a made-up .bwav) - the window: --selftest draws every screen (skipped without a display) """ import contextlib @@ -2514,42 +2514,6 @@ class LookTest(Tmp): with self.assertRaises(self.picture.PictureError): self.picture.read_ppm(b'P5\n1 1\n255\n\0') - def test_the_effects_are_short_wavs(self): - sound = self.sound - for name in sound.EFFECTS: - samples = sound.synth(name) - self.assertAlmostEqual(float(abs(samples).max()), 1.0, places=5, msg=name) - self.assertLess(len(samples) / sound.RATE, 1.0, name) - self.assertLess(abs(float(samples[-1])), 0.01, name) # it ends at nothing: no click - wav = sound.wav_bytes(samples, 0.4) - self.assertEqual(wav[:4] + wav[8:16], b'RIFFWAVEfmt ') - self.assertEqual(struct.unpack_from('