Files
BT411/scratchpad/loopaudit.py
T
arcattackandClaude Opus 5 d39227ef39 Gitea #51 ROOT CAUSE: LoopAtWill was mapped to "loop forever", arming 224 of 603 samples as endless OpenAL sources
SAURON's "coolant flush sound glitched and perma" is one instance of a systemic
defect.  SetupPatch (L4AUDLVL.cpp) decided looping from the SAMPLE flag alone:

    AL_LOOPING = (info.loop != ForceStatic)

That armed every non-ForceStatic sample -- 224 of the 603 authored zones,
including unmistakable one-shots -- as an OpenAL source that never ends on its
own.  Any such sound whose note-off never arrives plays forever.  Measured 1946
LoopAtWill x Transient arming events in one short session.

The sample flag expresses PERMISSION; the SOURCE decides.  Three facts [T1]:

  * the enum's own comments (L4AUDLVL.h:14-19) -- LoopAtWill = "will play once
    OR LOOP AS DESIRED", ForceStatic = "plays only once EVEN IF LOOPED" (a
    veto), LoopAlways = "ramp up and then down";
  * LoopAtWill is enum value 0, i.e. the DEFAULT an unauthored sample receives
    (WTPresets.cpp:37) -- it cannot mean "loop forever";
  * LoopAlways, the real always-loop, is used by ZERO shipped samples.

"As desired" is the source's authored AudioRenderType (Transient=one-shot vs
Sustained=held), streamed from AUDIO*.RES (AUDLVL.cpp:28) and already consulted
by the renderer (L4AUDRND.cpp:567, AUDREND.cpp:184).  SetupPatch now takes it,
threaded from all three L4AudioSource call sites (Direct/Dynamic3D/Static3D).
New rule: LoopAlways->1, ForceStatic->0, LoopAtWill->the source's render type.

MEASURED before changing behaviour (BT_LOOP_AUDIT=1, scratchpad/loopaudit.py):

    LoopAtWill  x Transient -> loop=0  (was 1)   1946 events
    LoopAtWill  x Sustained -> loop=1  unchanged    65 events
    ForceStatic x Transient -> loop=0  unchanged   292 events

The engine loops (EngineAccel07_z0..z2, EngineMotor01, EnginePower01) are all
LoopAtWill/Sustained and PRESERVED -- no regression there.  All 24 reclassified
samples are genuine one-shots: laser charge/fire/explosion/loaded, missile
loading, engine shift, coolant pressure inc/dec.

A/B PROOF (scratchpad/loopab.py, same session both arms, only BT_LOOP_LEGACY
differs), asking the engine's own BT_AUDIO_DUMP what is still playing with
loop=1 long after every release:

    [legacy] EnginePower01, CoolantPresInc03_z2, CoolantPresDcr03_z2
    [fixed]  EnginePower01

The two stuck coolant sources are the reported symptom.  They were eventually
reclaimed when a later trigger reused the source, which is why the bug was
intermittent -- the "perma" case is when nothing else retriggers it.  The fix
removes the mechanism.

BT_LOOP_LEGACY=1 restores the old rule for a field A/B without a rebuild.  The
layers to listen to are the beam sustains: LaserA/CSustain* are authored
LoopAtWill on a TRANSIENT source, so they now end with the sample instead of
looping until note-off.  The render type is T1 authored data; the interpretation
that LoopAtWill defers to it is a strong reading of the enum + defaults rather
than a disassembled statement, and is flagged as such in the KB.

Plausibly bears on #32 (audio cutting in/out late in a match): a stuck looping
source holds its pool slot for the rest of the round.

Rigs: scratchpad/flushsnd.py (flush start/stop pairing), flushsnd2.py (stuck-
source hunt), loopaudit.py (the classification matrix), loopab.py (the A/B).
KB: context/wintesla-port.md audio section, context/decomp-reference.md env
table (BT_LOOP_AUDIT / BT_LOOP_LEGACY / BT_AUDIO_DUMP / BT_AUD_TAIL),
docs/AUDIO_FIDELITY.md F38.  checkctx.py CLEAN.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-07-25 13:20:19 -05:00

115 lines
3.7 KiB
Python

"""Gitea #51 -- audit which sounds the LoopAtWill reclassification actually changes.
The old rule was `AL_LOOPING = (sample != ForceStatic)`, which made every one of the
224 non-ForceStatic samples an OpenAL source that never ends. The new rule defers a
LoopAtWill sample to the SOURCE's authored AudioRenderType (streamed from
AUDIO*.RES), which is what the enum comment says it means.
This run drives a normal solo session -- engine, walking, weapons, coolant flush --
with BT_LOOP_AUDIT=1 and tabulates every sound by (sample flag, source type) so the
reclassification is measured, not assumed. The load-bearing question:
* do the sustained loops (engine, wind) stay loop=1? <- must be YES
* which sounds flip [WAS 1, NOW 0]? <- must all be one-shots
Kills only the PID it spawns.
"""
import ctypes
import os
import re
import subprocess
import sys
import time
from collections import Counter
KEYUP = 0x0002
VK = {"W": 0x57, "H": 0x48, "C": 0x43, "SPACE": 0x20}
user32 = ctypes.windll.user32
REPO = r"C:\git\bt411"
LOG = os.path.join(REPO, "scratchpad_loopaudit.log")
if os.path.exists(LOG):
os.remove(LOG)
env = dict(os.environ)
env.update({
"BT_START_INSIDE": "1",
"BT_KEY_NOFOCUS": "1",
"BT_DEV_GAUGES": "1",
"BT_LOOP_AUDIT": "1",
"BT_AUTOFIRE": "1", # exercise weapon one-shots
"BT_LOG": LOG,
})
proc = subprocess.Popen(
[os.path.join(REPO, "build", "Release", "btl4.exe"), "-egg", "LAST.EGG"],
cwd=os.path.join(REPO, "content"), env=env,
stdout=subprocess.DEVNULL, stderr=subprocess.DEVNULL)
print("pid", proc.pid)
def hold(name, secs):
vk = VK[name]
user32.keybd_event(vk, 0, 0, 0)
time.sleep(secs)
user32.keybd_event(vk, 0, KEYUP, 0)
time.sleep(0.3)
try:
deadline = time.time() + 240
while time.time() < deadline:
if os.path.exists(LOG) and "first frame" in open(LOG, errors="replace").read():
break
time.sleep(2)
else:
print("FAIL: never reached the mission")
proc.terminate()
sys.exit(2)
time.sleep(6)
hold("W", 4.0) # throttle up -> engine + footfalls
hold("H", 0.6) # coolant flush
hold("C", 0.2) # valve
hold("H", 0.6) # flush again
time.sleep(8)
finally:
proc.terminate()
time.sleep(1)
t = open(LOG, errors="replace").read() if os.path.exists(LOG) else ""
lines = re.findall(r"^\[loop-audit\].*$", t, re.M)
combos = Counter()
flipped = {}
kept = {}
for l in lines:
m = re.search(r"file=(\S+) sample=(\S+) source=(\S+) -> loop=(\d)", l)
if not m:
continue
f, samp, src, lp = m.groups()
combos[(samp, src, lp)] += 1
if "[WAS 1, NOW 0]" in l:
flipped[f] = (samp, src)
elif lp == "1":
kept[f] = (samp, src)
print("\n=============== RESULT ===============")
print("[loop-audit] events:", len(lines))
print("\nclassification matrix (sample flag x source type -> loop):")
for (samp, src, lp), n in sorted(combos.items(), key=lambda kv: -kv[1]):
print(" %-12s x %-9s -> loop=%s (%d events)" % (samp, src, lp, n))
print("\nSTILL LOOPING (loop=1) -- these must be genuine sustained loops:", len(kept))
for f, (samp, src) in sorted(kept.items()):
print(" %-30s %s / %s" % (f, samp, src))
print("\nRECLASSIFIED to one-shot [WAS 1, NOW 0]:", len(flipped))
for f, (samp, src) in sorted(flipped.items()):
print(" %-30s %s / %s" % (f, samp, src))
engine_kept = [f for f in kept if "Engine" in f or "Wind" in f]
print("\nsustained engine/wind loops preserved:", engine_kept if engine_kept else "NONE -- INVESTIGATE")
print("\nVERDICT:", "measured -- review the two lists above" if lines
else "no [loop-audit] output (gate not firing?)")
sys.exit(0)