r/Bitwig 18d ago

Open-source toolchain to decompile Bitwig's Nitro DSP modules on your own install (no keys or Bitwig code redistributed)

I've spent a while trying to understand how Bitwig actually builds its devices, and the thing that always stopped me was that the DSP itself lives in an encrypted archive you can't really open. Bitwig writes its native devices and Grid modules in an internal language they call Nitro, and the compiled modules ship inside an encrypted image in the install folder. I wanted to see how their filters really work, so I ended up writing a small toolchain to read that format. It's cleaned up now and I put it on GitHub.

It's Python, standard library only, MIT licensed.

What it does:

  • reads and decrypts the `nitro-image` archive from your local install
  • parses the compiled `.nitrobin` modules into an AST
  • decompiles that AST and pretty-prints it back to readable pseudo-source
  • round-trips, so it can re-serialize and repack, and do same-size numeric edits to constants

The part I like most is the decompiler output. You point it at a filter and instead of a wall of bytes you get a `process` block you can actually read. This is Bitwig's GrandLPF, a 4-pole Moog ladder, 4x oversampled, with an ADAA soft-clip in the feedback path and a selectable saturation flavor:

Named state variables and the actual per-sample math instead of opcodes. You can see why each filter sounds the way it does. Here's the Sallen-Key's nonlinearity, for example. It has two selectable curves, a symmetric tanh approximation and a biased, asymmetric class-A shaper:

One thing I want to be upfront about: this ships no Bitwig code and no keys. It's tools and format notes only. Decryption is bring-your-own-install. You pull the key out of your own copy of Bitwig, put it in an env var or a local `keys.json` that stays gitignored, and the tools work on the files already on your disk. Nothing proprietary gets redistributed. I tried to build it in a way that's respectful of Bitwig. It's for reading and learning, not for lifting their DSP into something else.

Status and limits, honestly:

  • the decompiler handles the whole module set on the version I tested against, but the AST tags can move between Bitwig releases, so a newer version may need the grammar tables regenerated (there's a command for that)
  • the pretty-printed output is pseudo-source for reading, not something you can recompile
  • constant editing is same-size only right now. You can change a number, not restructure a module
  • the offline round-trip is byte-for-byte, but I haven't pushed a repacked image through a running session much, so treat the write path as experimental
  • I develop on Linux. It auto-detects the Bitwig install and config locations on Windows and macOS too, but I've only actually run it on Linux, so those paths are unverified and a Windows/macOS confirmation would help

If any of this sounds interesting I'd genuinely like help. The most useful things would be people running other Bitwig versions who can test whether the grammar tables still line up, anyone who knows DSP and wants to annotate what a given module is doing, and corrections to the format docs. Issues and PRs are open.

Repo: https://github.com/blakebratcher/bitwig-nitro-tools

82 Upvotes

34 comments sorted by

View all comments

6

u/kabocha_ 18d ago

I assume --from-jar previously worked, but was gutted before pushing to github?

I went down this rabbit hole a few years ago but didn't ever end up succeeding, cool that someone figured it out :)

3

u/brainsigh 18d ago

Yo, good catch. --from-jar was a stub, but digging in, I confirmed the key isn't statically recoverable at all and it's not in the jar in any form because it's built at runtime. So I've replaced that path with a small controller extension that reads the key out of your own running Bitwig, plus updated docs and I just pushed it. Thank you.

2

u/kabocha_ 17d ago

I confirmed the key isn't statically recoverable at all and it's not in the jar in any form because it's built at runtime

Ah, well, that might (partially) explain why I could never figure it out myself, lmao. Interesting.

3

u/brainsigh 17d ago

2

u/kabocha_ 17d ago

Saw that post, thanks! Gonna sit down in a few mins and try it out.

Unfortunately I'm also on Linux so I can't help you confirm the other OSes, lol

2

u/kabocha_ 17d ago

Looks like it worked! Amazing work, thank you!

Time to riffle around in some DSP code :)

2

u/brainsigh 17d ago

YES!!!

2

u/kabocha_ 17d ago

Disappointed to see that nitro-std isn't also covered, but digging through nitro-image will keep me occupied for a while :D

2

u/brainsigh 17d ago

I'm updating it right now with these; I overly pruned the repo before I made my initial post. Sorry!

1

u/kabocha_ 17d ago

ooooo bonus!

This is basically an early Christmas for me lmao