aboutsummaryrefslogtreecommitdiffstats
path: root/tools/gbmovie.py
diff options
context:
space:
mode:
authorgbc dev <gbc@localhost>2026-07-15 16:53:28 +0200
committergbc dev <gbc@localhost>2026-07-15 16:53:28 +0200
commit95fa3f0095d6f383840992cab6833cac92493a60 (patch)
treeb0ce39e89f15bdffbe38c3f1896750e702644952 /tools/gbmovie.py
parenttools: stitch_overworld.py - DFS EXPLORE's connection graph into one overworl... (diff)
downloadsl0pboy-95fa3f0095d6f383840992cab6833cac92493a60.tar.gz
sl0pboy-95fa3f0095d6f383840992cab6833cac92493a60.tar.xz
sl0pboy-95fa3f0095d6f383840992cab6833cac92493a60.zip
control: video frame capture + deterministic input-movie replay
Two socket features for building reproducible showcase clips: - record start <path> [everyN] / record stop: append the RGB888 framebuffer of each produced frame to a flat 'GBCV' capture file (downsample with everyN). tools/gbgif.py turns it into a GIF (or PNG frames). Capture is decoupled from wall-clock/turbo/frameskip, so timing is always correct. - input play <path> [reset] / input stop: drive the joypad from a synthesized TAS-style movie (text: '<frames> [buttons...]' per line), frame-locked so replay is deterministic. 'reset' does an exact power-on (preserve cart ROM+SRAM, zero all other state) so a movie replays byte-identically -- verified by hashing two runs. tools/gbmovie.py is a Python builder for movies.
Diffstat (limited to 'tools/gbmovie.py')
-rw-r--r--tools/gbmovie.py106
1 files changed, 106 insertions, 0 deletions
diff --git a/tools/gbmovie.py b/tools/gbmovie.py
new file mode 100644
index 0000000..dc92989
--- /dev/null
+++ b/tools/gbmovie.py
@@ -0,0 +1,106 @@
+#!/usr/bin/env python3
+"""Build TAS-style input movies for the gbc emulator's `input play` replayer.
+
+A movie is a text file of `<frames> [buttons...]` lines: hold the given buttons
+(a b start select up down left right; none/'-' = released) for that many frames.
+Blank lines and `# comments` are ignored. The emulator drives one line's worth
+of joypad state per emulated frame, so replay is deterministic:
+
+ ./gbctl input play /abs/demo.gbmv reset # reset + replay from boot
+ ./gbctl record start /abs/demo.gbv 2 # (optional) capture video
+ ...
+ ./gbctl record stop
+ python3 tools/gbgif.py demo.gbv demo.gif --scale 3
+
+Use as a library to synthesize demos:
+
+ from gbmovie import Movie
+ m = Movie()
+ m.wait(40) # let fastboot settle
+ m.hold("select", 8) # open the SL0P menu
+ m.wait(16)
+ m.tap("down", repeat=13) # cursor down to the last item
+ m.hold("a", 6) # select it
+ m.wait(600) # watch it run
+ m.save("demo.gbmv")
+
+Run this file directly to emit the sample demo above to stdout.
+"""
+from __future__ import annotations
+
+
+def _btns(buttons) -> str:
+ if buttons is None:
+ return ""
+ if isinstance(buttons, str):
+ buttons = buttons.split()
+ return " ".join(buttons)
+
+
+class Movie:
+ def __init__(self):
+ self._lines: list[str] = []
+ self._frames = 0
+
+ def hold(self, buttons, frames: int):
+ """Hold `buttons` (str/list) for `frames` frames."""
+ frames = int(frames)
+ if frames <= 0:
+ return self
+ b = _btns(buttons)
+ self._lines.append(f"{frames} {b}".rstrip())
+ self._frames += frames
+ return self
+
+ def wait(self, frames: int):
+ """Idle (no buttons) for `frames` frames."""
+ return self.hold(None, frames)
+
+ def tap(self, buttons, frames: int = 4, gap: int = 6, repeat: int = 1):
+ """Press `buttons` for `frames`, release for `gap`, `repeat` times.
+
+ The gap matters: the menu's low-sensitivity polling needs the button to
+ be released between presses to register a repeat."""
+ for _ in range(int(repeat)):
+ self.hold(buttons, frames)
+ if gap > 0:
+ self.wait(gap)
+ return self
+
+ def comment(self, text: str):
+ self._lines.append(f"# {text}")
+ return self
+
+ @property
+ def total_frames(self) -> int:
+ return self._frames
+
+ def render(self) -> str:
+ return "\n".join(self._lines) + "\n"
+
+ def save(self, path: str):
+ with open(path, "w") as f:
+ f.write(self.render())
+ return path
+
+
+def _sample() -> Movie:
+ m = Movie()
+ m.comment("SL0P demo: open menu -> last item (SAVER) -> watch it wander")
+ m.wait(340) # boot splash + fastboot -> overworld (~307f)
+ m.hold("select", 8)
+ m.wait(16)
+ m.tap("down", repeat=13)
+ m.hold("a", 6)
+ m.wait(600)
+ return m
+
+
+if __name__ == "__main__":
+ import sys
+ m = _sample()
+ if len(sys.argv) > 1:
+ m.save(sys.argv[1])
+ print(f"wrote {sys.argv[1]} ({m.total_frames} frames)")
+ else:
+ sys.stdout.write(m.render())