pygoattracker 0.1.2__tar.gz → 0.1.3__tar.gz

{pygoattracker-0.1.2 → pygoattracker-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pygoattracker
-Version: 0.1.2
+Version: 0.1.3
 Summary: Pure-Python reader, writer, and player for GoatTracker 2 (.SNG) songs
 Author: Josh Bailey
 License:                                  Apache License

{pygoattracker-0.1.2 → pygoattracker-0.1.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "pygoattracker"
-version = "0.1.2"
+version = "0.1.3"
 description = "Pure-Python reader, writer, and player for GoatTracker 2 (.SNG) songs"
 readme = "README.md"
 requires-python = ">=3.10"

{pygoattracker-0.1.2 → pygoattracker-0.1.3}/src/pygoattracker/player.py

@@ -89,9 +89,23 @@ class Player:
         adparam: int = constants.DEFAULT_ADPARAM,
         optimize_pulse: bool = True,
         optimize_realtime: bool = True,
+        freq_table=None,
     ):
         if not 0 <= subtune < len(song.subtunes):
             raise GoatTrackerError(f"no such subtune: {subtune}")
+        # The editor playroutine (gplay.c) reads a fixed note-frequency table
+        # zero-padded to 128 entries. The PACKED player (gt2reloc/player.s) lays
+        # the table out as ``freqtbllo[firstnote..lastnote]`` followed
+        # immediately by ``freqtblhi[...]`` with NO padding, then the songtable;
+        # an out-of-range note (a wavetable relative step past the last note)
+        # therefore overruns into the adjacent relocated memory and yields an
+        # image-specific frequency. ``freq_table`` lets a caller (the packed-SID
+        # decompiler) supply that exact 128-entry table read from the image so
+        # the render reproduces the packed player's overrun frequencies. When
+        # None the editor's zero-padded ``constants.FREQ_TABLE`` is used.
+        self._freq_table = (
+            constants.FREQ_TABLE if freq_table is None else tuple(freq_table)
+        )
         self.adparam = adparam & 0xFFFF
         self.optimize_pulse = optimize_pulse
         self.optimize_realtime = optimize_realtime
@@ -201,7 +215,7 @@ class Player:
         return self._rtable[table][(ptr - 1) & 0xFF]
 
     def _freq(self, note: int) -> int:
-        return constants.FREQ_TABLE[note & 0x7F]
+        return self._freq_table[note & 0x7F]
 
     def _speed_value(self, idx: int, chan: _Channel) -> int:
         """16-bit speedtable value; high bit selects realtime calculation."""

{pygoattracker-0.1.2 → pygoattracker-0.1.3}/src/pygoattracker.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pygoattracker
-Version: 0.1.2
+Version: 0.1.3
 Summary: Pure-Python reader, writer, and player for GoatTracker 2 (.SNG) songs
 Author: Josh Bailey
 License:                                  Apache License

{pygoattracker-0.1.2 → pygoattracker-0.1.3}/tests/test_player.py

@@ -89,6 +89,24 @@ def test_single_note_timeline(song):
     assert (constants.CONTROL_REG, 0x09) in frames[55]
 
 
+def test_freq_table_override(song):
+    """A per-instance ``freq_table`` overrides the editor's fixed note table so
+    the packed-SID decompiler can reproduce the packed player's overrun
+    frequencies (it lays the table out unpadded, so out-of-range notes read
+    adjacent image bytes). Default (None) keeps the editor table."""
+    # The default render emits C-4 at the standard table frequency.
+    base = play(Player(song), 60)
+    assert (constants.FREQ_LO_REG, C4_FREQ & 0xFF) in base[8]
+    assert (constants.FREQ_HI_REG, C4_FREQ >> 8) in base[8]
+    # Override note 48 (C-4) to an arbitrary image-specific value; the render
+    # now emits that frequency for the same note, nothing else changes.
+    table = list(constants.FREQ_TABLE)
+    table[48] = 0xBEEF
+    frames = play(Player(song, freq_table=table), 60)
+    assert (constants.FREQ_LO_REG, 0xEF) in frames[8]
+    assert (constants.FREQ_HI_REG, 0xBE) in frames[8]
+
+
 def test_keyoff_keyon(song):
     song.patterns[0].rows[4] = Row(note=constants.KEYOFF)
     song.patterns[0].rows[5] = Row(note=constants.KEYON)