mfreak-speech 0.1.0__tar.gz

mfreak_speech-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

mfreak_speech-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.

mfreak_speech-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.

mfreak_speech-0.1.0/PKG-INFO

@@ -0,0 +1,39 @@
+Metadata-Version: 2.5
+Name: mfreak-speech
+Version: 0.1.0
+Summary: Put your own words on the MicroFreak's Speech engine: LPC analysis, a firmware patch, and SysEx uploads, for microfreak-tools. Not affiliated with Arturia.
+Project-URL: Homepage, https://github.com/gbryant/microfreak-tools
+Project-URL: Issues, https://github.com/gbryant/microfreak-tools/issues
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Requires-Python: <3.15,>=3.11
+Requires-Dist: microfreak-tools<0.2,>=0.1.0
+Requires-Dist: numpy>=2.0
+Description-Content-Type: text/markdown
+
+# mfreak-speech
+
+Put your own words on the Arturia MicroFreak's Speech engine. A plugin for
+[microfreak-tools](https://github.com/gbryant/microfreak-tools). Not
+affiliated with Arturia.
+
+    uv tool install microfreak-tools --with mfreak-speech
+
+Hear words the way the instrument will say them, with no instrument needed:
+
+    mfreak speech preview "hello there"
+
+Putting them on the instrument needs its firmware patched first. This writes
+flash:
+
+    mfreak fw patch speech MicroFreak_Firmware_Update_5_0_0_2084.mff --out speech.mff
+    mfreak fw flash speech.mff
+    mfreak speech say "i am microfreak"
+
+`mfreak speech` shows every step. Download the stock 5.0.0.2084 `.mff` from
+the MicroFreak page on arturia.com. To remove the patch, flash the stock
+`.mff`. Read "Before you flash" in the microfreak-tools README first.
+
+Apache-2.0. The Speech synthesis is ported from Mutable Instruments Plaits,
+MIT; see NOTICE.

mfreak_speech-0.1.0/README.md

@@ -0,0 +1,25 @@
+# mfreak-speech
+
+Put your own words on the Arturia MicroFreak's Speech engine. A plugin for
+[microfreak-tools](https://github.com/gbryant/microfreak-tools). Not
+affiliated with Arturia.
+
+    uv tool install microfreak-tools --with mfreak-speech
+
+Hear words the way the instrument will say them, with no instrument needed:
+
+    mfreak speech preview "hello there"
+
+Putting them on the instrument needs its firmware patched first. This writes
+flash:
+
+    mfreak fw patch speech MicroFreak_Firmware_Update_5_0_0_2084.mff --out speech.mff
+    mfreak fw flash speech.mff
+    mfreak speech say "i am microfreak"
+
+`mfreak speech` shows every step. Download the stock 5.0.0.2084 `.mff` from
+the MicroFreak page on arturia.com. To remove the patch, flash the stock
+`.mff`. Read "Before you flash" in the microfreak-tools README first.
+
+Apache-2.0. The Speech synthesis is ported from Mutable Instruments Plaits,
+MIT; see NOTICE.

mfreak_speech-0.1.0/mfreak_speech/__init__.py

@@ -0,0 +1,82 @@
+"""mfreak-speech: speech vocabulary uploads, and the firmware patch they need."""
+from microfreak.plugin import Command, Firmware, Plugin
+
+_PATCHED = "Needs firmware patched by `fw patch speech`."
+
+GUIDE = """\
+Put your own words on the MicroFreak's Speech engine.
+
+  1. Hear them first. No instrument needed:
+       mfreak speech preview "hello there"
+     Give text, an audio file, or nothing to record yourself.
+
+  2. Install the speech firmware, once. Download the stock 5.0.0.2084 .mff
+     from the MicroFreak page on arturia.com. This writes flash:
+       mfreak fw patch speech MicroFreak_Firmware_Update_5_0_0_2084.mff --out speech.mff
+       mfreak fw flash speech.mff
+
+  3. Put words on it. Set the oscillator type to Speech; Shape picks the
+     word, Wave picks the bank:
+       mfreak speech say hello goodbye "thank you"
+       mfreak speech banks --bank one two --bank goodbye
+       mfreak speech banks --from vocab.txt
+     Switching the instrument off brings the factory words back.
+
+  4. Or make them permanent, in a firmware file to flash:
+       mfreak speech embed speech.mff --from vocab.txt --out speech-words.mff
+       mfreak fw flash speech-words.mff
+
+`mfreak speech banks --help` describes a vocabulary file. To remove the
+firmware, flash the stock .mff.
+
+Advanced: speech analyze, speech upload. Each has --help.
+"""
+
+plugin = Plugin(
+    name="speech",
+    help="put your own words on the Speech engine",
+    firmware=Firmware(
+        "mfreak_speech.firmware",
+        help="stock firmware that also takes speech vocabulary uploads",
+        identity="S"),
+    doctor="mfreak_speech.doctor",
+    guide=GUIDE,
+    commands={
+        "preview": Command(
+            "mfreak_speech.preview",
+            help="hear words as Speech, no instrument needed",
+            writes="file",
+            summary="Speak text, load audio or record, and play it back as "
+                    "the Speech engine would say it. No instrument or "
+                    "firmware needed."),
+        "analyze": Command(
+            "mfreak_speech.analyze",
+            help="convert speech audio to LPC frames",
+            writes="file", advanced=True,
+            summary="Convert speech audio to LPC frames and report what the "
+                    "engine will keep and drop. Offline."),
+        "say": Command(
+            "mfreak_speech.cli", ["say"],
+            help="put words on it (needs patched firmware)",
+            device=True, writes="device",
+            summary="Put words on the instrument, one per Shape position. "
+                    + _PATCHED),
+        "banks": Command(
+            "mfreak_speech.cli", ["banks"],
+            help="one word bank per Wave knob position",
+            device=True, writes="device",
+            summary="Upload one word bank per Wave knob position. " + _PATCHED),
+        "embed": Command(
+            "mfreak_speech.embed",
+            help="put your words in a firmware file",
+            image=True, writes="file",
+            summary="Wipe the word banks in a firmware file and write your "
+                    "own. Writes a file to flash with `fw flash`."),
+        "upload": Command(
+            "mfreak_speech.sysex",
+            help="the low-level SysEx uploader",
+            device=True, writes="device", advanced=True,
+            summary="The low-level SysEx uploader behind `say` and `banks`. "
+                    + _PATCHED),
+    },
+)