conco/OpenMaidEngine
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 3 Wiki Activity

Implement forced BGM opcodes

Browse Source
This commit is contained in:
gamer147
2026-07-29 12:38:54 -04:00
parent 137fae848f
commit 2908d38663
14 changed files with 259 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
engine/Age.Cli/Program.cs
View File

@@ -352,6 +352,13 @@ sealed class AudioTraceHost : IHost
var entry = _res.ResolveBgm(id);
Events.Add(("play-bgm", id, entry != null ? $"{entry.Archive} {entry.Name}" : $"BGM{id:D3}.OGG <missing>"));
}
public void RestartBgm(long id, int startMode)
{
var entry = _res.ResolveBgm(id);
string resolved = entry != null ? $"{entry.Archive} {entry.Name}" : $"BGM{id:D3}.OGG <missing>";
Events.Add((startMode == 0 ? "restart-bgm-once" : "restart-bgm-loop", id, resolved));
}
public void StopBgm() => Events.Add(("stop-bgm", 0, ""));
public void PlayVoice(long id) // voice: universal packed catalog id
{
var e = _res.ResolveVoice(id);

35
engine/Age.Engine.Tests/SfxOpsTests.cs
View File

@@ -30,6 +30,41 @@ public class SfxOpsTests
Assert.Equal("exit", vm.HaltReason);
Assert.Equal([24L, 25L, 25L], host.BgmTracks);
Assert.Equal((0, 0L), Assert.Single(host.BgmFades));
Assert.Equal(1, host.BgmStops);
}
[Fact]
public void ForcedBgmTrioRestartsWithNativeModesReusesCurrentAndStops()
{
var table = OpcodeTableJson.Load(Paths.OpcodesJson);
const int currentAfterStop = 0x100;
const int currentAfterRestart = 0x101;
var script = ScriptAssembler.Assemble(table, "BGM-FORCE",
new List<(int, Operand[])>
{
(0xbf, new[] { new Operand(0, 24) }),
(0xb7, new[] { new Operand(0, 24) }), // same track still restarts
(0xb7, new[] { new Operand(0, 0) }), // zero aliases retained track
(0xb9, new[] { new Operand(0, 0) }), // retained track, one-shot mode
(0xb9, new[] { new Operand(0, 25) }), // nonzero replaces retained track
(0xb8, Array.Empty<Operand>()),
(0xc0, new[] { new Operand(3, currentAfterStop) }),
(0xb7, new[] { new Operand(0, 0) }), // no retained track: idempotent stop
(0xbf, new[] { new Operand(0, 25) }),
(0xc0, new[] { new Operand(3, currentAfterRestart) }),
(0x2, Array.Empty<Operand>()),
}, Array.Empty<string>());
var host = new RecordingHost();
var vm = new VirtualMachine(script, table, host);
vm.Run();
Assert.Equal("exit", vm.HaltReason);
Assert.Equal([24L, 25L], host.BgmTracks);
Assert.Equal([(24L, 1), (24L, 1), (24L, 0), (25L, 0)], host.BgmRestartRequests);
Assert.Equal(2, host.BgmStops);
Assert.Equal(0, vm.Globals[currentAfterStop]);
Assert.Equal(25, vm.Globals[currentAfterRestart]);
}
[Fact]

4
engine/Age.Engine.Tests/TestSupport.cs
View File

@@ -43,6 +43,8 @@ internal class RecordingHost : IHost
public readonly List<(int Channel, int StartMode, long DelayMs)> ScheduledSfxStarts = new();
public readonly List<int> SfxReleases = new();
public readonly List<long> BgmTracks = new();
public readonly List<(long Track, int StartMode)> BgmRestartRequests = new();
public int BgmStops;
public readonly List<(int Target, long Duration)> BgmFades = new();
public readonly List<(int Category, int BasisPoints)> AudioVolumeChanges = new();
public readonly List<(int Category, bool Enabled)> AudioRouteChanges = new();
@@ -175,6 +177,8 @@ internal class RecordingHost : IHost
=> TextureDraws.Add((slot, sx, sy, w, h, dx, dy));
public (int Width, int Height) GetTextureSize(int slot) => (0, 0);
public void PlayBgm(long id) => BgmTracks.Add(id);
public void RestartBgm(long id, int startMode) => BgmRestartRequests.Add((id, startMode));
public void StopBgm() => BgmStops++;
public void PlayVoice(long id) => Voices.Add(id);
public void PlayVoice(long id, int playbackVariant)
{

5
engine/Age.Engine/Hosting/IHost.cs
View File

@@ -137,6 +137,11 @@ public interface IHost
void DrawTexture(int slot, int srcX, int srcY, int width, int height, int dstX, int dstY);
(int Width, int Height) GetTextureSize(int slot);
void PlayBgm(long id);
// Ordinary op 0xbf is VM-filtered so reasserting the current track is idempotent. Ops
// 0xb7/0xb9 deliberately bypass that guard and restart with logical loop/one-shot mode.
void RestartBgm(long id, int startMode) => PlayBgm(id);
// Op 0xb8 releases the current source rather than merely applying a zero-volume envelope.
void StopBgm() => FadeBgm(0, 0);
void PlayVoice(long id);
// Native voice playback retains a second start argument: ordinary dialogue passes 0,
// while History replay (0x1bd) passes 1. Existing non-audio hosts may ignore it.

27
engine/Age.Engine/Vm/VirtualMachine.cs
View File

@@ -786,6 +786,17 @@ public sealed class VirtualMachine
_host.ResetSceneContext();
}
private void RestartBgm(long requestedTrackId, int startMode)
{
if (requestedTrackId != 0)
_currentBgmTrackId = requestedTrackId;
if (_currentBgmTrackId == 0)
_host.StopBgm();
else
_host.RestartBgm(_currentBgmTrackId, startMode);
}
private FrameOutcome RunFrame(ExecFrame frame, FrameCause cause, long callId = 0)
{
ExecFrame? previousInteractiveFrame;
@@ -2421,6 +2432,16 @@ public sealed class VirtualMachine
}
return pc + 1;
}
case "restart-bgm-loop": // 0xb7: force start, including current-track/zero alias
RestartBgm(Read(a[0]), 1);
return pc + 1;
case "stop-bgm": // 0xb8: release source and clear retained track
_currentBgmTrackId = 0;
_host.StopBgm();
return pc + 1;
case "restart-bgm-once": // 0xb9: force start without decoder rewind at EOF
RestartBgm(Read(a[0]), 0);
return pc + 1;
case "get-current-bgm-track":
Write(a[0], _currentBgmTrackId);
return pc + 1;
@@ -2464,7 +2485,11 @@ public sealed class VirtualMachine
{
int targetPercent = (int)Read(a[0]);
_host.FadeBgm(targetPercent, Read(a[1]));
if (targetPercent == 0) _currentBgmTrackId = 0;
if (targetPercent == 0)
{
_currentBgmTrackId = 0;
_host.StopBgm();
}
return pc + 1;
}
case "get-audio-volume": // 0xc5 (category)(out basis points)