pydefmon 0.2.0__tar.gz

pydefmon-0.2.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

pydefmon-0.2.0/PKG-INFO

@@ -0,0 +1,150 @@
+Metadata-Version: 2.4
+Name: pydefmon
+Version: 0.2.0
+Summary: Python implementation of the defMON C64 tracker's file format and register-level player.
+Author-email: Josh Bailey <josh@vandervecken.com>
+License: GPL-3.0-or-later
+Project-URL: Homepage, https://github.com/anarkiwi/pydefmon
+Project-URL: Issues, https://github.com/anarkiwi/pydefmon/issues
+Project-URL: Source, https://github.com/anarkiwi/pydefmon
+Keywords: c64,sid,defmon,tracker,chiptune
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Multimedia :: Sound/Audio
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: wav
+Requires-Dist: pyresidfp; extra == "wav"
+Requires-Dist: numpy; extra == "wav"
+Provides-Extra: dev
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pylint; extra == "dev"
+Requires-Dist: black; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Provides-Extra: integration
+Requires-Dist: defmon-driver==0.3.0; extra == "integration"
+Requires-Dist: vice-driver==0.2.0; extra == "integration"
+Dynamic: license-file
+
+# pydefmon
+
+[![test](https://github.com/anarkiwi/pydefmon/actions/workflows/test.yml/badge.svg)](https://github.com/anarkiwi/pydefmon/actions/workflows/test.yml)
+[![PyPI](https://img.shields.io/pypi/v/pydefmon.svg)](https://pypi.org/project/pydefmon/)
+
+Read, write and play [defMON](https://csdb.dk/release/?id=199997) C64
+tracker tunes from Python. The player emits the same per-frame SID
+register writes as the real defMON binary — verified byte-for-byte by
+[a live-VICE integration test](tests/integration/test_player_vs_real.py)
+that compares pydefmon's per-frame output against the actual defMON
+binary running in `anarkiwi/headlessvice`.
+
+## Install
+
+```bash
+pip install pydefmon          # core
+pip install pydefmon[wav]     # adds pyresidfp + numpy for WAV render
+```
+
+## Quick start
+
+```python
+from pydefmon import DefmonSong, DefmonPlayer, PatternEvent
+
+# Read / edit / write tunes
+song = DefmonSong.from_file("tune.prg")
+print(song.pattern_events(0)[:4])
+print(song.sidtab_row(0))
+song.set_step(0, v1=1, v2=2, v3=3)        # arranger row 0 plays patterns 1/2/3
+song.to_file("out.prg")
+
+# Render per-frame SID writes
+player = DefmonPlayer(song)
+for _ in range(600):
+    writes = player.play_frame()           # list of (reg, value) for one main-tick NMI
+    for reg, value in writes:
+        # reg is an absolute SID register address $D400..$D418
+        ...
+```
+
+Render to WAV (requires the `[wav]` extra):
+
+```bash
+pydefmon-player path/to/tune.prg /tmp/tune.wav
+```
+
+Dump per-frame SID writes as JSONL without rendering audio:
+
+```bash
+pydefmon-player --dump-writes /tmp/tune.jsonl path/to/tune.prg
+```
+
+## What's in the package
+
+- [`DefmonSong`](pydefmon/defmon.py) — the 22887-byte runtime RAM image
+  at `$1800..$7166`, parsed from a `.prg` file. Region accessors for
+  arrangers, sidTAB rows + DL bytes, pattern bodies; structured edit
+  API (`set_step`, `set_jump`, `set_dl`, `set_jp`,
+  `set_pattern_events`). Round-trips through the `$D6C9` LOAD codec.
+- [`PatternEvent`](pydefmon/defmon.py) — one 4-byte pattern step
+  (`flag, slot_a, slot_b, note`) with flag-bit constants and
+  factories (`note_on`, `delay`, `alt_end`).
+- [`SidtabRow`](pydefmon/defmon.py) — one 15-byte sidTAB row decoded
+  to named column attributes (`WGh / WGl / AD / SR / TR / AF / PW`
+  low half; `PS / RE / FV / CP / ACID` high half) plus its companion
+  `jp` and `dl` bytes.
+- [`SidcallFrame`](pydefmon/defmon.py) — one frame of a cascade walk
+  via `DefmonSong.sidcall_frames(start_row)`.
+- [`DefmonPlayer`](pydefmon/defmon_player.py) — frame-accurate
+  per-NMI player IRQ model. `play_frame()` returns the 24 SID
+  register writes that defMON's `$1022` body would emit for one
+  main player tick. `import_runtime_state()` lets you bridge from
+  a live VICE / hardware RAM capture for byte-faithful continuation
+  of a running tune.
+
+See [`docs/SPEC.md`](docs/SPEC.md) for the canonical reference of
+the file format, the runtime RAM layout, and what every cell of
+every region means.
+
+## Tests
+
+```bash
+pip install -e .[dev]
+python -m tools.fetch_fixtures        # one-time: populate build/fixtures/
+python -m unittest discover -s tests -t .
+```
+
+The unit tests under `tests/` pin every subsystem of the player and
+codec against synthetic `.prg` fixtures and against the .GLOW WORM
+fixture (Tomek Grynfelder, in the upstream defMON release).
+`tools/fetch_fixtures.py` downloads the upstream csdb.dk archive,
+extracts the `.d64`, and writes per-PRG files under
+`build/fixtures/` (override with the `PYDEFMON_FIXTURES_DIR` env
+var). Tunes are not redistributed; tests that need a fixture
+`skipTest` when it is missing.
+
+The live-VICE integration test under `tests/integration/` boots the
+real defMON binary inside `anarkiwi/headlessvice`, captures its SID
+write stream, and asserts pydefmon's `DefmonPlayer` matches
+byte-for-byte. Run with:
+
+```bash
+pip install -e .[dev,integration]
+PYDEFMON_INTEGRATION=1 python -m unittest tests.integration.test_player_vs_real
+```
+
+CI runs all three (`test`, `lint`, `build`, `integration`) on push
+and PR. Python 3.10 through 3.13.
+
+## License
+
+GPL-3.0-or-later. See [`LICENSE`](LICENSE).

pydefmon-0.2.0/README.md

@@ -0,0 +1,112 @@
+# pydefmon
+
+[![test](https://github.com/anarkiwi/pydefmon/actions/workflows/test.yml/badge.svg)](https://github.com/anarkiwi/pydefmon/actions/workflows/test.yml)
+[![PyPI](https://img.shields.io/pypi/v/pydefmon.svg)](https://pypi.org/project/pydefmon/)
+
+Read, write and play [defMON](https://csdb.dk/release/?id=199997) C64
+tracker tunes from Python. The player emits the same per-frame SID
+register writes as the real defMON binary — verified byte-for-byte by
+[a live-VICE integration test](tests/integration/test_player_vs_real.py)
+that compares pydefmon's per-frame output against the actual defMON
+binary running in `anarkiwi/headlessvice`.
+
+## Install
+
+```bash
+pip install pydefmon          # core
+pip install pydefmon[wav]     # adds pyresidfp + numpy for WAV render
+```
+
+## Quick start
+
+```python
+from pydefmon import DefmonSong, DefmonPlayer, PatternEvent
+
+# Read / edit / write tunes
+song = DefmonSong.from_file("tune.prg")
+print(song.pattern_events(0)[:4])
+print(song.sidtab_row(0))
+song.set_step(0, v1=1, v2=2, v3=3)        # arranger row 0 plays patterns 1/2/3
+song.to_file("out.prg")
+
+# Render per-frame SID writes
+player = DefmonPlayer(song)
+for _ in range(600):
+    writes = player.play_frame()           # list of (reg, value) for one main-tick NMI
+    for reg, value in writes:
+        # reg is an absolute SID register address $D400..$D418
+        ...
+```
+
+Render to WAV (requires the `[wav]` extra):
+
+```bash
+pydefmon-player path/to/tune.prg /tmp/tune.wav
+```
+
+Dump per-frame SID writes as JSONL without rendering audio:
+
+```bash
+pydefmon-player --dump-writes /tmp/tune.jsonl path/to/tune.prg
+```
+
+## What's in the package
+
+- [`DefmonSong`](pydefmon/defmon.py) — the 22887-byte runtime RAM image
+  at `$1800..$7166`, parsed from a `.prg` file. Region accessors for
+  arrangers, sidTAB rows + DL bytes, pattern bodies; structured edit
+  API (`set_step`, `set_jump`, `set_dl`, `set_jp`,
+  `set_pattern_events`). Round-trips through the `$D6C9` LOAD codec.
+- [`PatternEvent`](pydefmon/defmon.py) — one 4-byte pattern step
+  (`flag, slot_a, slot_b, note`) with flag-bit constants and
+  factories (`note_on`, `delay`, `alt_end`).
+- [`SidtabRow`](pydefmon/defmon.py) — one 15-byte sidTAB row decoded
+  to named column attributes (`WGh / WGl / AD / SR / TR / AF / PW`
+  low half; `PS / RE / FV / CP / ACID` high half) plus its companion
+  `jp` and `dl` bytes.
+- [`SidcallFrame`](pydefmon/defmon.py) — one frame of a cascade walk
+  via `DefmonSong.sidcall_frames(start_row)`.
+- [`DefmonPlayer`](pydefmon/defmon_player.py) — frame-accurate
+  per-NMI player IRQ model. `play_frame()` returns the 24 SID
+  register writes that defMON's `$1022` body would emit for one
+  main player tick. `import_runtime_state()` lets you bridge from
+  a live VICE / hardware RAM capture for byte-faithful continuation
+  of a running tune.
+
+See [`docs/SPEC.md`](docs/SPEC.md) for the canonical reference of
+the file format, the runtime RAM layout, and what every cell of
+every region means.
+
+## Tests
+
+```bash
+pip install -e .[dev]
+python -m tools.fetch_fixtures        # one-time: populate build/fixtures/
+python -m unittest discover -s tests -t .
+```
+
+The unit tests under `tests/` pin every subsystem of the player and
+codec against synthetic `.prg` fixtures and against the .GLOW WORM
+fixture (Tomek Grynfelder, in the upstream defMON release).
+`tools/fetch_fixtures.py` downloads the upstream csdb.dk archive,
+extracts the `.d64`, and writes per-PRG files under
+`build/fixtures/` (override with the `PYDEFMON_FIXTURES_DIR` env
+var). Tunes are not redistributed; tests that need a fixture
+`skipTest` when it is missing.
+
+The live-VICE integration test under `tests/integration/` boots the
+real defMON binary inside `anarkiwi/headlessvice`, captures its SID
+write stream, and asserts pydefmon's `DefmonPlayer` matches
+byte-for-byte. Run with:
+
+```bash
+pip install -e .[dev,integration]
+PYDEFMON_INTEGRATION=1 python -m unittest tests.integration.test_player_vs_real
+```
+
+CI runs all three (`test`, `lint`, `build`, `integration`) on push
+and PR. Python 3.10 through 3.13.
+
+## License
+
+GPL-3.0-or-later. See [`LICENSE`](LICENSE).

pydefmon-0.2.0/pydefmon/__init__.py

@@ -0,0 +1,62 @@
+"""Python reader / writer / player for defMON C64 tracker tunes.
+
+Top-level API:
+
+* :class:`DefmonSong` — read / edit / write defMON ``.prg`` files
+  via :meth:`DefmonSong.from_file` and :meth:`DefmonSong.to_file`.
+* :class:`PatternEvent` — one 4-byte step in a pattern body
+  (flag + slot_a + slot_b + note).
+* :class:`SidtabRow` — one 15-byte sidTAB row (per-frame envelope
+  / timbre / filter program; bitmap-encoded columns).
+* :class:`SidcallFrame` — one row of a sidTAB cascade walk
+  starting from a given row index.
+* :class:`DefmonPlayer` — frame-accurate per-NMI player IRQ model
+  (byte-faithful against the real defMON binary running in
+  asid-vice, verified by the integration test suite).
+* :class:`Voice` — per-voice runtime record exposed for
+  introspection / programmatic poking.
+
+Constants:
+
+* :data:`LOAD_ADDRESS` — ``$1800``, where defMON tunes load.
+* :data:`STANDARD_SNAPSHOT_END` / :data:`STANDARD_SNAPSHOT_SIZE`
+  — the runtime RAM image end (``$7167``) and length (22887).
+* :data:`NOTE_PITCH_LO` / :data:`NOTE_PITCH_HI` — 128-byte
+  note-to-SID-freq LUTs the player walks.
+
+For raw byte-level work on defMON's ``$D6C9`` LOAD codec, see
+:mod:`pydefmon._load_format` (private). Most users only need
+:class:`DefmonSong` and :class:`DefmonPlayer`.
+"""
+
+from pydefmon.defmon import (
+    DefmonError,
+    DefmonSong,
+    LOAD_ADDRESS,
+    NOTE_PITCH_HI,
+    NOTE_PITCH_LO,
+    PatternEvent,
+    SidcallFrame,
+    SidtabRow,
+    STANDARD_SNAPSHOT_END,
+    STANDARD_SNAPSHOT_SIZE,
+)
+from pydefmon.defmon_player import DefmonPlayer, Voice
+
+__all__ = [
+    "DefmonError",
+    "DefmonPlayer",
+    "DefmonSong",
+    "LOAD_ADDRESS",
+    "NOTE_PITCH_HI",
+    "NOTE_PITCH_LO",
+    "PatternEvent",
+    "SidcallFrame",
+    "SidtabRow",
+    "STANDARD_SNAPSHOT_END",
+    "STANDARD_SNAPSHOT_SIZE",
+    "Voice",
+    "__version__",
+]
+
+__version__ = "0.2.0"