bitcomposer 1.2.0rc4__tar.gz → 2.0.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (142) hide show
  1. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/PKG-INFO +191 -102
  2. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/README.md +190 -101
  3. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/__init__.py +1 -1
  4. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/cli.py +74 -3
  5. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/instruments.py +4 -1
  6. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/names.py +2 -0
  7. bitcomposer-2.0.0/bitcomposer/packs/__init__.py +62 -0
  8. bitcomposer-2.0.0/bitcomposer/packs/bit.py +437 -0
  9. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/packs/evermore.py +22 -0
  10. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/packs/ffvi.py +35 -0
  11. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/packs/library.py +8 -3
  12. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/packs/mana.py +25 -0
  13. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/packs/megamanx.py +23 -0
  14. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/packs/packfile.py +7 -1
  15. bitcomposer-2.0.0/bitcomposer/performance.py +213 -0
  16. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/player/app.py +4 -1
  17. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/player/backend.py +32 -5
  18. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/player/engine.py +8 -0
  19. bitcomposer-2.0.0/bitcomposer/player/fonts/OFL-Silkscreen.txt +93 -0
  20. bitcomposer-2.0.0/bitcomposer/player/fonts/Silkscreen-Bold.ttf +0 -0
  21. bitcomposer-2.0.0/bitcomposer/player/fonts/Silkscreen-Regular.ttf +0 -0
  22. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/player/icons/bitcomposer.svg +9 -5
  23. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/player/openmpt.py +6 -0
  24. bitcomposer-2.0.0/bitcomposer/player/qml/Main.qml +1855 -0
  25. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/player/window.py +1 -1
  26. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/samples/__init__.py +11 -3
  27. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/score.py +11 -3
  28. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/spc/__main__.py +4 -3
  29. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/translate/pack.py +51 -8
  30. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/translate/packtables.py +29 -15
  31. bitcomposer-2.0.0/bitcomposer/translate/reading.py +232 -0
  32. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/translate/rhythm/__init__.py +3 -2
  33. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/translate/rhythm/arrangement.py +159 -12
  34. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/translate/rhythm/readings.py +63 -6
  35. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/translate/store.py +23 -0
  36. bitcomposer-2.0.0/bitcomposer/translate/whole/__init__.py +5 -0
  37. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/translate/whole/measures.py +10 -3
  38. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/translate/whole/plan.py +36 -9
  39. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/translate/whole/render.py +213 -45
  40. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/translate/writer/upper.py +2 -0
  41. bitcomposer-2.0.0/bitcomposer/vocabularies/__init__.py +176 -0
  42. bitcomposer-2.0.0/bitcomposer/vocabularies/default.json.gz +0 -0
  43. bitcomposer-2.0.0/bitcomposer/written.py +101 -0
  44. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer.egg-info/PKG-INFO +191 -102
  45. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer.egg-info/SOURCES.txt +11 -1
  46. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/pyproject.toml +2 -1
  47. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/tests/test_arrangement.py +1 -1
  48. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/tests/test_determinism.py +6 -12
  49. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/tests/test_format.py +1 -1
  50. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/tests/test_library.py +4 -3
  51. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/tests/test_packfile.py +26 -1
  52. bitcomposer-2.0.0/tests/test_performance.py +172 -0
  53. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/tests/test_player.py +75 -1
  54. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/tests/test_score.py +19 -0
  55. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/tests/test_tables.py +176 -0
  56. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/tests/test_whole.py +222 -1
  57. bitcomposer-2.0.0/tests/test_written.py +255 -0
  58. bitcomposer-1.2.0rc4/bitcomposer/packs/__init__.py +0 -30
  59. bitcomposer-1.2.0rc4/bitcomposer/player/qml/Main.qml +0 -2120
  60. bitcomposer-1.2.0rc4/bitcomposer/translate/reading.py +0 -97
  61. bitcomposer-1.2.0rc4/bitcomposer/translate/whole/__init__.py +0 -5
  62. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/LICENSE +0 -0
  63. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/__main__.py +0 -0
  64. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/arp.py +0 -0
  65. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/bass.py +0 -0
  66. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/builder.py +0 -0
  67. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/composer.py +0 -0
  68. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/drums.py +0 -0
  69. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/echo.py +0 -0
  70. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/harmony.py +0 -0
  71. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/it_format.py +0 -0
  72. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/melody.py +0 -0
  73. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/mix.py +0 -0
  74. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/pattern.py +0 -0
  75. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/player/__init__.py +0 -0
  76. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/player/__main__.py +0 -0
  77. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/player/audio.py +0 -0
  78. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/player/autostart.py +0 -0
  79. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/player/desktop.py +0 -0
  80. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/player/fonts/JetBrainsMono-Bold.ttf +0 -0
  81. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/player/fonts/JetBrainsMono-Regular.ttf +0 -0
  82. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/player/fonts/LICENSE.txt +0 -0
  83. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/player/mediakeys_win.py +0 -0
  84. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/player/mpris.py +0 -0
  85. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/player/update.py +0 -0
  86. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/registers.py +0 -0
  87. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/samples/chip.py +0 -0
  88. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/samples/dsp.py +0 -0
  89. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/samples/genesis.py +0 -0
  90. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/samples/snes.py +0 -0
  91. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/spc/__init__.py +0 -0
  92. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/spc/brr.py +0 -0
  93. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/spc/convert.py +0 -0
  94. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/spc/emulate.py +0 -0
  95. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/spc/it_song.py +0 -0
  96. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/spc/notes.py +0 -0
  97. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/spc/snes_chip.py +0 -0
  98. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/spc/tuning.py +0 -0
  99. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/structure.py +0 -0
  100. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/theory.py +0 -0
  101. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/translate/__init__.py +0 -0
  102. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/translate/__main__.py +0 -0
  103. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/translate/against.py +0 -0
  104. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/translate/archives.py +0 -0
  105. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/translate/beat.py +0 -0
  106. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/translate/drums.py +0 -0
  107. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/translate/events.py +0 -0
  108. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/translate/form.py +0 -0
  109. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/translate/games.py +0 -0
  110. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/translate/harmony.py +0 -0
  111. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/translate/harness.py +0 -0
  112. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/translate/lead.py +0 -0
  113. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/translate/measures.py +0 -0
  114. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/translate/phase.py +0 -0
  115. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/translate/phrases.py +0 -0
  116. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/translate/reference.py +0 -0
  117. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/translate/rhythm/cells.py +0 -0
  118. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/translate/rhythm/chords.py +0 -0
  119. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/translate/rhythm/form.py +0 -0
  120. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/translate/roles.py +0 -0
  121. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/translate/tables.py +0 -0
  122. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/translate/vocab.py +0 -0
  123. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/translate/writer/__init__.py +0 -0
  124. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/translate/writer/figures.py +0 -0
  125. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/translate/writer/parts.py +0 -0
  126. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer/translate/writer/tune.py +0 -0
  127. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer.egg-info/dependency_links.txt +0 -0
  128. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer.egg-info/entry_points.txt +0 -0
  129. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer.egg-info/requires.txt +0 -0
  130. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/bitcomposer.egg-info/top_level.txt +0 -0
  131. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/setup.cfg +0 -0
  132. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/tests/test_lead.py +0 -0
  133. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/tests/test_packs.py +0 -0
  134. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/tests/test_pattern.py +0 -0
  135. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/tests/test_samples.py +0 -0
  136. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/tests/test_spc.py +0 -0
  137. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/tests/test_spc_check.py +0 -0
  138. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/tests/test_spc_convert.py +0 -0
  139. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/tests/test_spc_notes.py +0 -0
  140. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/tests/test_theory.py +0 -0
  141. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/tests/test_translate.py +0 -0
  142. {bitcomposer-1.2.0rc4 → bitcomposer-2.0.0}/tests/test_writer.py +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: bitcomposer
3
- Version: 1.2.0rc4
3
+ Version: 2.0.0
4
4
  Summary: Procedural 16-bit chiptune music generator — creates Impulse Tracker (.it) files
5
5
  Author-email: CatDogBark <catdogbark@pm.me>
6
6
  License-Expression: MIT
@@ -36,29 +36,31 @@ Dynamic: license-file
36
36
  [![Release](https://img.shields.io/github/v/release/CatDogBark/bitComposer)](https://github.com/CatDogBark/bitComposer/releases/latest)
37
37
  ![License](https://img.shields.io/badge/license-MIT-green)
38
38
 
39
- Procedural 16-bit game music. A player that composes the next song as the
40
- current one ends, with a live mixer, on Linux and Windows; a command line
41
- and a generator library underneath, pure Python with no dependencies,
39
+ 16-bit game music, written while you listen. A player that writes the next
40
+ song as the current one ends, with a live mixer, on Linux and Windows; a
41
+ command line and a library underneath, pure Python with no dependencies,
42
42
  writing Impulse Tracker `.it` modules any tracker player reads.
43
43
 
44
- Every run composes a new song: a motif-based melody with call-and-response
45
- phrasing, voice-led harmony, bass, arpeggio and drums, arranged into a form
46
- (verse–chorus, AABA, rondo, through-composed) with a drawn intro, an energy
47
- curve and a real ending, titled after what it drew, between 1:15 and 3:30
48
- long. Seven sounds, picked with `--sound`:
44
+ Since 2.0 every song is written the way game soundtracks are put together:
45
+ drawn whole from a vocabulary of counted habits (how the band is balanced,
46
+ how its figures repeat and vary, where the tune comes back), taken from
47
+ the readings of a soundtrack's songs. The vocabulary that ships was
48
+ learned from Final Fantasy VI's 67 songs, as statistics with none of the
49
+ game's notes or samples. The songs play on bitComposer's own sound set,
50
+ generic instruments synthesised here, on one of Classic's four styled
51
+ sets, or on a game's own samples. More under [What GENERATE
52
+ writes](#what-generate-writes).
49
53
 
50
- - **snes** — sampled-style voices built the way the SNES made sound, through a BRR codec model and the SNES echo.
51
- - **ffvi**, **mana**, **evermore**, **megamanx** — style packs: an instrument set rebuilt from each game's own sound chip (every sample profiled, nothing copied) plus the arrangement habits of its score. Details under [Sounds](#sounds).
52
- - **genesis** — FM bells, brass, organ and bass.
53
- - **chip** — square, pulse and triangle waves. Closest to NES and Game Boy.
54
+ Your own games too: the player's LIBRARY screen reads a game's SPC files
55
+ into a pack of its samples and, with 40 songs or more, a vocabulary of its
56
+ own to write from ([Packs from your games](#packs-from-your-games)).
54
57
 
55
- And packs of your own: the player's PACKS panel makes one from a game's
56
- own SPC files, the game's samples as its voices ([Packs from your
57
- games](#packs-from-your-games)).
58
+ The 1.x generator stays as [Classic](#classic), with its own knobs and
59
+ seven sounds, the chip and Genesis palettes among them.
58
60
 
59
- **[Listen in your browser](https://catdogbark.github.io/bitComposer/)** — the actual modules, played live by libopenmpt in WebAssembly: one song per sound, straight from the generator, regenerated with each release.
61
+ **[Listen in your browser](https://catdogbark.github.io/bitComposer/)** — the actual modules, played live by libopenmpt in WebAssembly: five songs from the writer, seeds 1 to 5, and one each from six of Classic's sounds.
60
62
 
61
- **Reproducible, not frozen.** The same seed on the same version gives the same song, byte for byte. A new version may change what a seed draws, and the song message records the version that wrote the file.
63
+ **Reproducible, not frozen.** The same seed on the same version gives the same song, byte for byte. A new version may change what a seed draws; a Classic song's message records the version that wrote it.
62
64
 
63
65
  ## Install
64
66
 
@@ -84,7 +86,7 @@ with its icon); from then on start it from there like any other program.
84
86
  The command line is `bitcomposer`, e.g. `bitcomposer -d out -s 42 -v` for
85
87
  a reproducible song with details. To make packs from a game's music
86
88
  ([below](#packs-from-your-games)) the player needs the SNES emulator too:
87
- `pipx install "bitcomposer[import]"` installs both, or the PACKS panel's
89
+ `pipx install "bitcomposer[import]"` installs both, or LIBRARY's
88
90
  GET THE EMULATOR adds it later.
89
91
 
90
92
  The player needs libopenmpt (above) and an audio output: `paplay`
@@ -119,7 +121,163 @@ anything built on libopenmpt.
119
121
  Python 3.10 or newer. The generator has no dependencies; the player's
120
122
  window is Qt (PySide6, installed with the package).
121
123
 
122
- ## Sounds
124
+ ## What GENERATE writes
125
+
126
+ ```bash
127
+ bitcomposer -s 7 -v
128
+ ```
129
+
130
+ writes a whole song the way the idiom's writer does ([docs/IDIOM.md](docs/IDIOM.md)): a
131
+ plan for the band, each part's figures bar by bar, a tune with a theme that
132
+ may come back, and the parts' balance, all drawn from a vocabulary of
133
+ counted habits, played on bitComposer's own sound set (generic
134
+ instruments, synthesised here from descriptions and modelled on no game's
135
+ bank, each fitted to its part by register and speed; `--pack ffvi`,
136
+ `mana`, `evermore` or `megamanx` borrows one of Classic's styled sets
137
+ instead) and rendered through the SNES back end, under the player's
138
+ performance (`bitcomposer/performance.py`): the theme comes back with the
139
+ band, the loop plays twice, the echo and the vibrato on held notes of the tune
140
+ are the vocabulary's own words (FFVI's 0.20 echo at 80 ms, its vibrato on a
141
+ fifth of the tune's held notes). `--bare` writes without
142
+ it, the way the Song Checks do; `--no-carry-theme` and `--no-band-returns`
143
+ turn the two switches off. A seed names one song on
144
+ every machine. `--carry-theme` draws the tune's phrases again until its
145
+ theme comes back; `--band-returns` brings the chords, the bass or the
146
+ accompaniment back with it. In the player this is GENERATE on PLAY,
147
+ and WRITE AND PLAY on WRITE, where the two switches and a seed field sit;
148
+ [Classic](#classic), the 1.x generator, is WRITER: CLASSIC (1.X) there
149
+ (`--classic` on the command line).
150
+
151
+ Where the vocabulary comes from, plainly: the shipped one
152
+ (`bitcomposer/vocabularies/default.json.gz`, 377 KB) was fitted on the
153
+ readings of Final Fantasy VI's 67 songs, the game the writing was
154
+ measured against round by round until it held up by ear
155
+ ([docs/idiom/phase-4-writing.md](docs/idiom/phase-4-writing.md)). It is the statistics of how that
156
+ music is put together, the counts of figures, moves, chord changes and
157
+ balances, and none of the game's samples or notes; a release check
158
+ (`tools/copycheck.py`) probes every four-bar window of hundreds of
159
+ written tunes against the games' phrases and ships nothing that copies
160
+ one. It is as far as the writing has gone; vocabularies fitted on more
161
+ games follow. Importing a game (below) fits that game's own vocabulary
162
+ beside its samples and recounts one over everything you have imported;
163
+ WRITE offers each under WRITTEN FROM once 40 songs stand behind it
164
+ (`--vocabulary pack:NAME`, `--vocabulary library`).
165
+
166
+ Every word in the vocabulary, what it counts and why it exists, is in
167
+ [the vocabulary](docs/idiom/VOCABULARY.md), and [the vocabulary's
168
+ map](docs/idiom/vocabulary-map.md) draws, stage by stage, which words
169
+ condition which.
170
+
171
+ ## Packs from your games
172
+
173
+ The player's LIBRARY screen makes a pack from a game's own
174
+ music. IMPORT a game's SPC set (a folder of `.spc` files, a zip, or
175
+ snesmusic.org's `.rsn`, a `.rar` or a `.7z`, which 7-Zip or unar on your
176
+ machine unpacks) and each song is run through an emulator of the SNES sound
177
+ hardware, read as music (the beat and bar, which voice is the melody, the
178
+ bass, the chords and the drums, the form) and the soundtrack made into a
179
+ pack: the samples the game plays each part with most, as its voices, a kit
180
+ of its drums, and the habits the readings give straight (tempo, major or
181
+ minor, how often a song has no drums, the echo). SOUNDS shows each voice in
182
+ its part, to hear it, see why it was put there (in how many songs, how
183
+ many notes) and move it; USE ITS SOUNDS plays the next songs on them;
184
+ EXPORT writes the pack as one zip, and ADD A PACK brings an exported pack,
185
+ or a pack file, back. Importing a game again
186
+ starts its pack fresh.
187
+
188
+ An import also counts the game's own tables into its pack. With 40 songs
189
+ or more behind it the game has a vocabulary of its own: WRITE FROM IT in
190
+ LIBRARY, or its card under WRITE's WRITTEN FROM, writes the next songs the
191
+ way that game's are put together, and a library vocabulary recounted over
192
+ everything you have imported sits beside them (`--vocabulary pack:NAME`,
193
+ `--vocabulary library`). Under 40 songs a fitted vocabulary's drums are
194
+ not yet the game's, so none is offered.
195
+
196
+ The emulator, `bitcomposer-emu`, is a compiled package of its own with a
197
+ wheel for Linux (x86_64 and aarch64), Windows and macOS, so no toolchain
198
+ is needed. The Windows build carries it. On Linux,
199
+ `pipx install "bitcomposer[import]"` installs both, or the panel's GET THE
200
+ EMULATOR adds it to a player already installed, and UPDATE keeps both
201
+ current (`pip install "bitcomposer[import]"` elsewhere). Where no wheel
202
+ matches, it builds from source (Rust; CONTRIBUTING.md has how).
203
+
204
+ From the command line, `python -m bitcomposer.spc --pack OUT FOLDER|ARCHIVE`
205
+ makes a pack (`bitcomposer --pack-file OUT/pack.json` composes with it);
206
+ `python -m bitcomposer.spc --to-it song.it game.spc` converts one song to
207
+ an IT module, one to one, its samples, notes, envelopes and echo (how well,
208
+ over 1836 songs of 39 games and 20 music drivers, is in `docs/drivers/`);
209
+ and `python -m bitcomposer.translate FOLDER` prints each song's reading,
210
+ with `--against PACK` measuring songs composed with a pack beside them.
211
+
212
+ The SPC files are yours: bitComposer ships none, and the packs made from
213
+ them stay on your machine, in your data folder
214
+ (`~/.local/share/bitcomposer/packs` on Linux,
215
+ `%LOCALAPPDATA%\bitComposer\packs` on Windows).
216
+
217
+ ## The player
218
+
219
+ <img src="docs/images/player.png" alt="The player: PLAY, with the song, the transport, GENERATE, the band's levels and the songs" width="400">
220
+
221
+ `bitcomposer-player` (Linux) and `bitComposer.exe` (Windows) are the same
222
+ program, an application of four screens under one header:
223
+
224
+ - **PLAY**: the song playing, its position, the transport, GENERATE, AUTO
225
+ (the "radio": the next song is written when this one ends), gain with a
226
+ soft limiter, each channel's level as the band, and the songs in the
227
+ folder with KEEP. Every song the player writes is provisional
228
+ (`(auto) <Title>.it`, so a file browser sorts them together) and pruned
229
+ after ten unless kept.
230
+ - **WRITE**: what the next song is written from (the vocabulary that
231
+ ships, your library, or a game you have read), the two switches (carry
232
+ a theme; the band returns with it), a seed that names one song on any
233
+ machine, and the sounds it plays on. Classic, the 1.x generator, is a
234
+ switch at the bottom, with its own knobs (sound, tempo, energy, scale,
235
+ form, echo, bass, drums, harmony) and presets.
236
+ - **LIBRARY**: the games you have read. IMPORT reads a game's SPC set
237
+ into its sounds and, at 40 songs, its own vocabulary; ADD brings in an
238
+ exported pack; each game can lend its sounds, be written from,
239
+ be exported, renamed or deleted.
240
+ - **SOUNDS**: a game's samples by part, each heard with a click and moved
241
+ when the reading got it wrong.
242
+
243
+ MIX (a live mixer per channel, with the kit and the echo as buses, and
244
+ APPLY to write the mix into the file) and SET (start at login, update
245
+ checks, release candidates) open as panels over the screen. The look is
246
+ the SNES era's own pixels, as styling only: the controls are ordinary
247
+ controls, the text is text, nothing sits on a fixed grid. The window
248
+ opens no taller than the screen it lands on (scrolling on a small or
249
+ scaled screen) and keeps the size you give it; Ctrl + and Ctrl − zoom
250
+ it, Ctrl 0 resets, Ctrl 1 to 4 pick a screen. Closing the window leaves
251
+ the music playing in the tray (quit from the tray menu), and starting it
252
+ again brings that window back rather than a second player. The media keys
253
+ drive it: on Linux through the desktop's media controls (MPRIS, so the
254
+ Plasma media applet and lock screen, GNOME and `playerctl` see it too),
255
+ on Windows as global keys. SET → LOGIN, or the tray menu, starts it when
256
+ you log in: in the tray, not playing. When a newer release exists an
257
+ UPDATE button appears in the header. It says what the update will do,
258
+ then shows it happening: on Linux it reinstalls through pipx, pipx's
259
+ output scrolling past, and restarts the player; on Windows it downloads
260
+ the release's installer and runs it. A player installed from a release
261
+ candidate is offered the next candidate; a release player only releases,
262
+ unless SET → CANDIDATES asks for candidates too.
263
+
264
+ ## Classic
265
+
266
+ Classic is the 1.x generator, kept whole in 2.0: WRITER: CLASSIC (1.X) on
267
+ the player's WRITE screen, `--classic` on the command line. It has no
268
+ vocabulary. Every run composes a new song from rules and tables of its
269
+ own: a motif-based melody with call-and-response phrasing, voice-led
270
+ harmony, bass, arpeggio and drums, arranged into a form (verse–chorus,
271
+ AABA, rondo, through-composed) with a drawn intro, an energy curve and a
272
+ real ending, titled after what it drew, between 1:15 and 3:30 long. Seven
273
+ sounds, picked with `--sound`:
274
+
275
+ - **snes** — sampled-style voices built the way the SNES made sound, through a BRR codec model and the SNES echo.
276
+ - **ffvi**, **mana**, **evermore**, **megamanx** — style packs: an instrument set rebuilt from each game's own sound chip (every sample profiled, nothing copied) plus the arrangement habits of its score. Details under [Sounds](#sounds).
277
+ - **genesis** — FM bells, brass, organ and bass.
278
+ - **chip** — square, pulse and triangle waves. Closest to NES and Game Boy.
279
+
280
+ ### Sounds
123
281
 
124
282
  A style pack pairs an instrument set with the arrangement habits of the score it imitates. Each is built from the game's SPC snapshots: every sample decoded and profiled, matched to the community's instrument tables where they exist, and re-synthesised; nothing from the games is in the repository.
125
283
 
@@ -134,9 +292,9 @@ A style pack pairs an instrument set with the arrangement habits of the score it
134
292
  - **genesis** — FM bells, brass, organ and bass.
135
293
  - **chip** — square, pulse and triangle waves.
136
294
 
137
- ## What you can steer
295
+ ### What you can steer
138
296
 
139
- Everything defaults to `random`.
297
+ With `--classic`, everything defaults to `random`; without it these options are not read.
140
298
 
141
299
  ```
142
300
  --sound chip|snes|genesis|ffvi|mana|evermore|megamanx the sound in one word: a palette or a style pack (overrides the two below)
@@ -166,19 +324,19 @@ Some starting points:
166
324
 
167
325
  ```bash
168
326
  # Overworld — bright, sampled palette with echo
169
- bitcomposer -d out --style snes --scale major --tempo medium --form standard
327
+ bitcomposer --classic -d out --style snes --scale major --tempo medium --form standard
170
328
 
171
329
  # FM boss fight
172
- bitcomposer -d out --style genesis --tempo fast --energy intense --scale minor --drum-density busy --form short
330
+ bitcomposer --classic -d out --style genesis --tempo fast --energy intense --scale minor --drum-density busy --form short
173
331
 
174
332
  # Game Boy flavour — square waves, thin harmony, no echo
175
- bitcomposer -d out --style chip --echo off --harmony-voicing thin --bass-weight light --form short
333
+ bitcomposer --classic -d out --style chip --echo off --harmony-voicing thin --bass-weight light --form short
176
334
 
177
335
  # Credits roll
178
- bitcomposer -d out --style snes --tempo slow --energy chill --scale major --drum-density sparse --no-fills --form linear
336
+ bitcomposer --classic -d out --style snes --tempo slow --energy chill --scale major --drum-density sparse --no-fills --form linear
179
337
  ```
180
338
 
181
- ## How it works
339
+ ### How it works
182
340
 
183
341
  1. Pick a key and a scale weighted toward game music (minor pentatonic, dorian, harmonic minor, mixolydian…), then a progression for it. The tables include borrowed chords and secondary dominants — ♭VII, ♭VI, V/V — not just the diatonic set.
184
342
  2. Choose a form and its energy curve; decide which sections repeat. Repeated sections draw the same music from the same seed, so the hook comes back.
@@ -208,7 +366,10 @@ python3 tools/analyze.py --grid out/song.it # tracker-style pattern dump
208
366
  [docs/ANALYSIS.md](docs/ANALYSIS.md) is the story of this project: the
209
367
  output was once limited by three silent arrangement bugs that nine commits
210
368
  of ear-checking never caught, and every improvement since has been measured
211
- before and after. Read it before changing the generator.
369
+ before and after. Read it before changing Classic. The writer has its own
370
+ record: [docs/IDIOM.md](docs/IDIOM.md) for the plan, and [docs/idiom/phase-4-writing.md](docs/idiom/phase-4-writing.md)
371
+ for its rounds, each measured against Final Fantasy VI's own songs and
372
+ passed by ear.
212
373
 
213
374
  Tests:
214
375
 
@@ -216,81 +377,9 @@ Tests:
216
377
  python3 -m unittest discover -s tests -v
217
378
  ```
218
379
 
219
- ## Packs from your games
220
-
221
- New in 1.2, and early. The player's PACKS panel makes a pack from a game's
222
- own music. IMPORT a game's SPC set (a folder of `.spc` files, a zip, or
223
- snesmusic.org's `.rsn`, a `.rar` or a `.7z`, which 7-Zip or unar on your
224
- machine unpacks) and each song is run through an emulator of the SNES sound
225
- hardware, read as music (the beat and bar, which voice is the melody, the
226
- bass, the chords and the drums, the form) and the soundtrack made into a
227
- pack: the samples the game plays each part with most, as its voices, a kit
228
- of its drums, and the habits the readings give straight (tempo, major or
229
- minor, how often a song has no drums, the echo). OPEN a pack to hear each
230
- voice in its part, see why it was put there (in how many songs, how many
231
- notes) and move it; USE puts it in SOUND; EXPORT writes it as one zip, and
232
- ADD brings an exported pack, or a pack file, back. Importing a game again
233
- starts its pack fresh.
234
-
235
- A pack carries the game's sound; how a song is arranged is still
236
- bitComposer's own, measured against the game's songs. The next stages
237
- teach the generator to write the way the readings show the composers did
238
- (`docs/TRANSLATOR.md`).
239
-
240
- The emulator, `bitcomposer-emu`, is a compiled package of its own with a
241
- wheel for Linux (x86_64 and aarch64), Windows and macOS, so no toolchain
242
- is needed. The Windows build carries it. On Linux,
243
- `pipx install "bitcomposer[import]"` installs both, or the panel's GET THE
244
- EMULATOR adds it to a player already installed, and UPDATE keeps both
245
- current (`pip install "bitcomposer[import]"` elsewhere). Where no wheel
246
- matches, it builds from source (Rust; CONTRIBUTING.md has how).
247
-
248
- From the command line, `python -m bitcomposer.spc --pack OUT FOLDER|ARCHIVE`
249
- makes a pack (`bitcomposer --pack-file OUT/pack.json` composes with it);
250
- `python -m bitcomposer.spc --to-it song.it game.spc` converts one song to
251
- an IT module, one to one, its samples, notes, envelopes and echo (how well,
252
- over 1836 songs of 39 games and 20 music drivers, is in `docs/drivers/`);
253
- and `python -m bitcomposer.translate FOLDER` prints each song's reading,
254
- with `--against PACK` measuring songs composed with a pack beside them.
255
-
256
- The SPC files are yours: bitComposer ships none, and the packs made from
257
- them stay on your machine, in your data folder
258
- (`~/.local/share/bitcomposer/packs` on Linux,
259
- `%LOCALAPPDATA%\bitComposer\packs` on Windows).
260
-
261
- ## The player
262
-
263
- <img src="docs/images/player.png" alt="The player: now playing, transport, gain, generate, settings, mix and packs, the playlist" width="400">
264
-
265
- `bitcomposer-player` (Linux) and `bitComposer.exe` (Windows) are the same
266
- program: a folder of songs played through libopenmpt, GENERATE AND PLAY,
267
- auto-generate when a track ends (the "radio"), the settings of what it
268
- composes (sound, tempo, energy, scale, form, echo, bass, drums, harmony)
269
- with presets, a live mixer per channel with the KIT and ECHO buses and
270
- APPLY TO TRACK to write the mix into the file, gain with a soft limiter,
271
- shuffle, and the playlist with KEEP: every track the player makes is
272
- provisional (`(auto) <Title>.it`, so a file browser sorts them together)
273
- and pruned after ten unless kept. It
274
- opens no taller than the screen it lands on, the
275
- SET, MIX and PACKS panels open inside it (scrolling on a small or scaled
276
- screen), and it keeps the size you give it; Ctrl + and
277
- Ctrl − zoom it, Ctrl 0 resets. Closing the window leaves the music playing
278
- in the tray (quit from the tray menu), and starting it again brings that
279
- window back rather than a second player. The media keys drive it: on
280
- Linux through the desktop's media controls (MPRIS, so the Plasma media
281
- applet and lock screen, GNOME and `playerctl` see it too), on Windows as
282
- global keys. SET → PLAYER → LOGIN, or the tray menu, starts it when you
283
- log in: in the tray, not playing. When a newer
284
- release exists an UPDATE button appears. It says what the update will do,
285
- then shows it happening: on Linux it reinstalls through pipx, pipx's
286
- output scrolling past, and restarts the player; on Windows it downloads
287
- the release's installer and runs it. A player installed from a release candidate is
288
- offered the next candidate; a release player only releases, unless
289
- SET → PLAYER → CANDIDATES asks for candidates too.
290
-
291
380
  ## Windows
292
381
 
293
- Every release carries `bitComposer-setup.exe` (the installer) and `bitComposer-windows.zip` (the same `bitComposer` folder, no install), built by GitHub Actions on every push to main and attached on the tag: `bitComposer.exe`, the player, with Qt, libopenmpt and the SNES emulator (for importing a game's music) beside it; and `bitcomposer-cli.exe`, the command line. The installer installs for your user by default (no administrator prompt; all users is an option on its first page), and the player's UPDATE button runs the next one quietly and reopens the player. Each build also renders the player offscreen at common screen sizes and scalings (1366×768, 1920×1080 at 100% and 150%, 2560×1440 at 125%, 4K at 200%), kept as the workflow's `player-screenshots-windows` artifact. Songs are `.it` files; [OpenMPT](https://openmpt.org) and XMPlay play them too. Windows releases are to be code-signed through the SignPath Foundation's programme for open-source projects (see [Code signing policy](#code-signing-policy)); until that is in place they are unsigned, so SmartScreen asks once ("More info", "Run anyway"). With Python installed instead, `pipx install bitcomposer` gives the same programs as `bitcomposer-player` and `bitcomposer`.
382
+ Every release carries `bitComposer-setup.exe` (the installer) and `bitComposer-windows.zip` (the same `bitComposer` folder, no install), built by GitHub Actions on every pull request into main and attached on the tag: `bitComposer.exe`, the player, with Qt, libopenmpt and the SNES emulator (for importing a game's music) beside it; and `bitcomposer-cli.exe`, the command line. The installer installs for your user by default (no administrator prompt; all users is an option on its first page), and the player's UPDATE button runs the next one quietly and reopens the player. Each build also renders the player offscreen at common screen sizes and scalings (1366×768, 1920×1080 at 100% and 150%, 2560×1440 at 125%, 4K at 200%), kept as the workflow's `player-screenshots-windows` artifact. Songs are `.it` files; [OpenMPT](https://openmpt.org) and XMPlay play them too. Windows releases are to be code-signed through the SignPath Foundation's programme for open-source projects (see [Code signing policy](#code-signing-policy)); until that is in place they are unsigned, so SmartScreen asks once ("More info", "Run anyway"). Smart App Control, where Windows 11 has it on, blocks unsigned programs outright with no such choice; bitComposer runs only with it off (Windows Security, App & browser control). With Python installed instead, `pipx install bitcomposer` gives the same programs as `bitcomposer-player` and `bitcomposer`.
294
383
 
295
384
  ## Code signing policy
296
385
 
@@ -311,7 +400,7 @@ bitComposer composes and plays music on your computer. It collects nothing about
311
400
 
312
401
  One thing goes over the network on its own: when the player starts, it asks GitHub's public releases list (`api.github.com`) whether a newer version exists, so it can offer the UPDATE button. That request carries only what any web request does (your IP address and the program's name), and [GitHub's privacy statement](https://docs.github.com/site-policy/privacy-policies/github-general-privacy-statement) covers it. Turn it off in the player under SET → PLAYER → UPDATES. Updating itself downloads only when you press UPDATE: the installer from GitHub on Windows, the package from PyPI with pipx. GET THE EMULATOR downloads the emulator from PyPI the same way, and only when you press it. Importing a game's music reads your files on your machine and sends nothing.
313
402
 
314
- The [listening page](https://catdogbark.github.io/bitComposer/) is a website: GitHub Pages serves it and Google Fonts serves its font, each under its own privacy policy. It plays the songs in your browser and keeps nothing.
403
+ The [listening page](https://catdogbark.github.io/bitComposer/) is a website: GitHub Pages serves it and Google Fonts serves its fonts, each under its own privacy policy. It plays the songs in your browser and keeps nothing.
315
404
 
316
405
  ## License and contact
317
406