microfreak-tools 0.1.0__tar.gz

microfreak_tools-0.1.0/.gitignore

@@ -0,0 +1,22 @@
+__pycache__/
+*.pyc
+.venv/
+dist/
+build/
+*.egg-info/
+
+# Arturia's binaries are NEVER committed here. Firmware payloads, .mff
+# containers, bootloader dumps and factory vocabulary are the user's own
+# property and every command takes them as an explicit argument. See NOTICE.
+*.mff
+*.raw
+*.bin
+# SysEx dumps and audio the tools produce. A .syx or a .wav off the
+# instrument is the user's own data, the same as the binaries above, and
+# `audition` writes WAVs when pointed at a directory with --out-dir.
+*.syx
+*.wav
+
+# Scratch space: anything in ignored/ stays out of git.
+ignored/
+.DS_Store

microfreak_tools-0.1.0/.python-version

@@ -0,0 +1 @@
+3.14

microfreak_tools-0.1.0/AGENTS.md

@@ -0,0 +1,147 @@
+# Driving `mfreak` from a program
+
+This file is for an LLM or a script operating this tool for someone. It covers
+what `--help` does not: which commands are dangerous, which facts are easy to
+get wrong, and how to check your work.
+
+Start with:
+
+    mfreak capabilities
+
+It returns JSON describing every command: whether it needs an instrument or a
+firmware image, what it writes, its flags, and a one-line summary. It is
+generated from the command table, so prefer it to anything written here.
+
+## The JSON contract
+
+`--json` works on every command.
+
+* **stdout is exactly one JSON object.** Human-readable output goes to stderr.
+* **Exit codes:** `0` success, `1` the operation failed, `2` bad usage.
+* Every object carries `ok`, `command` and `exit`. On exit 1 it also carries
+  `error`. On exit 2 it does not; the message is on stderr.
+* Read the exit code first and the object second.
+
+```
+$ mfreak preset read 8 --json
+{"ok": true, "command": "preset read", "exit": 0,
+ "slot": 7, "panel": 8, "name": "08 Waveshaper", "bytes": 4672, "out": null}
+
+$ mfreak preset decode /nope.mfpz --json ; echo $?
+{"ok": false, "command": "preset decode", "exit": 1,
+ "error": "/nope.mfpz: no such file"}
+1
+```
+
+These commands report structured detail: `doctor`, `capabilities`,
+`preset read`, `preset write`, `preset select`, `preset encode`,
+`preset decode`, `sample encode`, `wavetable encode`, `asset info`,
+`plugins`, `speech preview`, `speech analyze` and `peek dump-bootloader`.
+The rest report only
+`ok`, `command`, `exit` and `error`, so branch on the exit code.
+
+## Hard rules
+
+**Pass the number the instrument shows**: presets 1-512, samples 1-128,
+wavetables 1-16. If the user says "preset 180", pass `180`. Applying an offset
+writes to the neighbouring preset and destroys it.
+
+`--json` reports both `panel` (the number shown) and `slot` (`panel - 1`, the
+0-based index MIDI uses). **Read `panel`, and never pass `slot` back in.**
+
+**Never run a command whose `writes` is `"flash"` without explicit human
+confirmation in the current conversation.** Read that set from
+`capabilities`; today it is exactly two:
+
+* `fw flash` writes the instrument's flash, and can leave it unresponsive.
+  By default it writes every image in the file. `fw flash FILE --plan`
+  sends nothing and needs no instrument.
+* `fw enter` writes no firmware, but clears image 0's validity marker and
+  reboots into the bootloader. The instrument is unusable until
+  power-cycled.
+
+Recovery from either is holding SHIFT + ARP + OCT/MOD at power-on. Say so
+before you suggest one.
+
+**Treat `writes: "device"` as needing confirmation too.** It overwrites a
+preset, sample or wavetable. It is reversible only if you read the slot first
+and kept the file. Sample audio cannot be read back at all.
+
+**`peek dump-bootloader` writes a file containing the instrument's serial
+number.** Its JSON says so with `contains_serial` and `do_not_publish`. Never
+paste that file, or any hex from it, into anything shared. `--redact-serial`
+blanks the serial.
+
+**Never commit or upload firmware, bootloader dumps or factory vocabulary.**
+They belong to Arturia and the user. Both repositories' `.gitignore` refuse
+`*.mff`, `*.raw`, `*.bin`, `*.syx` and `*.wav`.
+
+## Working with no instrument
+
+Eleven commands need nothing plugged in and no firmware image: `asset import`,
+`asset info`, `capabilities`, `capture analyze`, `doctor`, `plugins`,
+`preset convert`, `preset decode`, `preset encode`, `sample encode` and
+`wavetable encode`, and with the speech plugin, `speech preview` and
+`speech analyze`. That list is generated from `capabilities` as
+`needs_nothing`, and `tests/test_cli_surface.py` checks this copy against it.
+
+`mfreak doctor --offline --json` is the right first call on an unknown
+machine. It reports `ready` and a `missing` list, and exits 0 when the offline
+path works. **An unplugged instrument is not a failure.**
+
+To exercise the device commands without hardware, use the emulator:
+
+    mfemu serve --preset 7=Speech          # leave running, from microfreak-emu
+    MFREAK_EMULATOR=1 mfreak preset read 7 --json
+
+Run with `MFREAK_EMULATOR=1` from the **microfreak-emu** checkout, which has
+both packages. From this checkout the import fails and the command says so.
+
+## Plugins
+
+`speech` and `peek` commands come from plugins, and exist only when the plugin
+is installed. `mfreak plugins --json` lists what is installed, and
+`capabilities` includes their commands. Each plugin also adds a patch,
+`fw patch speech` or `fw patch peek`. A command from a plugin that is not
+installed exits 2 and says how to install it. Do not install one without
+asking.
+
+## Two name traps
+
+`capture analyze` reads a recorded SysEx/MIDI capture. `speech analyze` reads
+audio. They are different commands.
+
+`preset decode` takes either the 4,672-byte file `preset read --out` writes or
+a 4,088-byte decoded block. It refuses anything else.
+
+## Checking your own work
+
+* `preset write`, `sample write` and `wavetable write` read the slot back
+  unless `--no-verify`. Their JSON carries `verified`: `true`, `false`, or
+  `null` when skipped. Treat `null` as unverified.
+* **A failed read-back exits 1.** `config write` does the same, and lists the
+  settings that failed in `failed`. So do `preset restore`, `preset erase`,
+  `sample restore`, `sample erase`, `wavetable restore` and `wavetable erase`,
+  which check each slot they change.
+* Those commands also carry `written`: `false` when nothing was written (no `--yes`),
+  `true` once sent. A dry run reports the same `slot` and `panel` the real
+  write would use.
+* **In JSON, `slot` is always 0-based and `panel` is always `slot + 1`**, in
+  every command including `asset info` and `sample list`.
+* `sample encode` and `wavetable encode` decode their own output and compare.
+  A mismatch writes nothing and exits non-zero.
+* `fw patch` refuses any image but stock firmware 5.0.0.2084. If it refuses,
+  the image is wrong. Do not look for a way to force it.
+* `tests/test_cli_surface.py` runs commands through `python -c "from
+  microfreak.cli import main; ..."` rather than `-m microfreak.cli`. Keep it
+  that way: under `-m`, some Python 3.14 patch releases print the wrong usage
+  line and the test fails. The same applies to `mfemu()` in microfreak-emu.
+
+## Where a claim comes from
+
+The evidence for every format and protocol claim is in **microfreak-emu**,
+under `docs/`: `FORMATS.md` for presets, `PROTOCOL.md` for SysEx, `SPEECH.md`
+for the LPC engine, `FIRMWARE.md` for the firmware map, and `METHOD.md` for
+retracted measurements. Cite those rather than inventing a justification. If a
+document contradicts the code, the code is what ships; say that they disagree
+instead of picking one silently.

microfreak_tools-0.1.0/CLAUDE.md

@@ -0,0 +1,28 @@
+# Writing help text and docs
+
+`--help` output comes from module docstrings, so a docstring is user-facing text.
+Write it for someone who wants to run the command, not for someone reviewing it.
+
+- Say what the command does, what to type, and what happens. Stop there.
+- Do not argue for the design. No "why X rather than Y", no "that is what X is for".
+- No history. Nothing about what used to be true, earlier builds, bugs that were
+  fixed, or retractions. That goes in commit messages, or in
+  microfreak-emu's docs/METHOD.md.
+- Do not answer objections nobody raised, and do not cite tests as proof.
+- Give a number only if it changes what the user does. "About a minute", not
+  "11.5 emulated seconds at 3.45x".
+- Say each thing once, at the level where it is needed. The top-level summary
+  lists commands. Procedures and caveats go on the command they belong to.
+- Option help is one line where possible: what it does, its default, and a
+  warning if it is dangerous.
+- Plain sentences. No em-dash asides, no ALL-CAPS or bold in mid-sentence, no
+  rhetorical openers like "Because" or "So".
+- Danger is the exception to brevity: anything that writes flash, overwrites a
+  slot, or produces a file containing the serial number says so plainly.
+
+AGENTS.md is for a program driving the tool. It states rules and contracts, not
+the history of how they came to be.
+
+The format docs (PRESET_FORMAT, SAMPLE_ENCODING) can be long, because
+they hold evidence. The same rules apply to their prose: state findings and the
+evidence for them, without arguing or narrating how they were reached.

microfreak_tools-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.

microfreak_tools-0.1.0/NOTICE

@@ -0,0 +1,103 @@
+microfreak-tools
+Copyright 2025-2026 Greg Bryant
+
+This product includes software developed as original work by the above
+copyright holder, licensed under the Apache License, Version 2.0 (see
+LICENSE).
+
+It also includes third-party material, which is licensed separately and
+retains its own copyright. The sections below are the attributions those
+licenses require.
+
+
+================================================================================
+Mutable Instruments Plaits -- MIT
+================================================================================
+
+The MicroFreak's Speech engine is Mutable Instruments' Plaits LPC speech
+synthesiser. This was established by byte-exact comparison against
+`pichenettes/eurorack`, not by inference: the 14-byte frame struct, the
+15-entry phoneme table, the quantisation lookup tables, the 640-entry
+excitation pulse, and the word banks all match the published MIT source
+value for value. The evidence is recorded in the companion
+analysis repository, microfreak-emu.
+
+Because that upstream source is MIT, the tables in this repository are
+redistributable under the terms below. They are Emilie Gillet's work, not
+Arturia's and not this project's.
+
+The following files contain material derived from `pichenettes/eurorack`:
+
+    microfreak/lpc.py
+                       the energy, period and k0..k9 quantisation tables, and
+                       the LPC bitstream layout, from
+                       plaits/dsp/speech/lpc_speech_synth_controller.cc and
+                       plaits/dsp/speech/lpc_speech_synth.h
+
+    plugins/speech/mfreak_speech/render.py
+                       a Python port of LPCSpeechSynth, and the 640-entry
+                       int8 excitation pulse `lut_lpc_excitation_pulse`,
+                       from plaits/dsp/speech/lpc_speech_synth.cc and
+                       plaits/resources.cc
+
+Copyright 2016 Emilie Gillet.
+
+Author: Emilie Gillet (emilie.o.gillet@gmail.com)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+
+================================================================================
+Texas Instruments LPC10 speech data -- NOT redistributed
+================================================================================
+
+Plaits' five factory word banks are, in its own description, "LPC10-encoded
+speech data extracted from Texas Instruments ROMs". The MicroFreak's banks
+match them byte for byte.
+
+This repository does not contain that data and must not come to contain it.
+The tooling reads the banks out of a firmware image the user already owns,
+at run time, and never writes them into source or into a committed artefact.
+Keep it that way: the MIT licence covering the Plaits code around them is
+not an obvious grant for speech recorded off a TI ROM, and nothing here
+depends on redistributing it.
+
+
+================================================================================
+Arturia -- no code, no binaries, no affiliation
+================================================================================
+
+This project is not affiliated with, authorised by, endorsed by or connected
+to Arturia in any way. "Arturia" and "MicroFreak" are trademarks of their
+respective owners and are used here only to identify the hardware this
+tooling was written for.
+
+No Arturia code or data is included in this repository, and none should
+ever be added to it. There are no firmware images, no bootloader dumps, no
+factory vocabulary banks, no factory presets and no protocol captures here --
+not gitignored copies of them, not samples of them, none. `.gitignore` refuses
+`*.mff`, `*.raw` and `*.bin` as a second line of defence, but the first is that
+every command takes the file it needs as an explicit argument.
+
+Nothing is downloaded either. `fw patch` requires `--image`, pointing at a
+payload you already own, and refuses any payload whose sha256 is not the one
+its addresses were derived against.
+
+Source comments and docstrings here describe observed behaviour and give
+addresses within a firmware image. They do not reproduce it.