Skip to content
ltgcgoPublic

About

🎻 State tracker, file parser, file serialiser. Event-driven multi-standard MIDI tool chain with insane support coverage.

Topics

Resources

Stars

63 stars

Watchers

3 watching

Forks

Latest commit

Β 

History

1,986 Commits

Folders and files

NameName
Last commit message
Last commit date
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Octavia

Warning

While using AI to help understand the codebase is allowed, using AI to contribute without knowledge is strictly forbidden for this project. People using AI models to contribute without understanding will be banned. Read AGENT.md for further details.

🎻 Event-driven multi-standard MIDI tool chain. State tracking, parsing, serializing.

Made with ❀️ by Lightingale Community. Repository available on Codeberg and GitHub.

Not sure how to explain to people what Octavia is? Here is our marketing pitch ready to be copied and pasted!

Maintainability.

Warning

Due to a critical bug affecting the SysEx interpretation flow (#55) as well as upcoming design requirements of MICC and Mist Veil, Octavia Lyre will be rewritten fully to produce the 3rd generation of the interpreting state tracker. The rewrite will happen before the 0.5.3 or 0.6 release.

If you're accessing the online version, it is advised to use the stable branch instead in case of a massive break. If you can see the address bar already at /octavia-stable/ or you're running a local development build, ignore the warning.

Warning

Octavia may work on Node.js, but support for it is never first-class, since we do not bootlick any single runtime. As this module is web-compliant standard ESM, to use on Node.js, a minimal web-compliant shim is required. Please check for the clean-up script from Fly Leaf.

Except via compatibility layers, there is no plan to ever put runtimes that offers non-ES compliance on first-class support. This means that only capable browsers, Deno and its direct descedants sharing the same web-first vision are the first-class support targets. Read more in the runtimes section.

Octavia is only ever published to JSR, with only its compatibility layers published to NPMJS to help transition off Node.js ecosystems. If you see Octavia fully published to other registries, report those fake packages immediately as they may contain malware.

What is Octavia?

The current MIDI landscape is a dumpster fire, at least in the FOSS world. Only proprietary software solutions respect existing MIDI standards, while the FOSS ecosystem largely ignores or even violates the conventions, with TiMidity as the single exception. Octavia, born out of being fed up by the existing antics exhibited by existing FOSS solutions, aims to reach full compliance with existing MIDI standards (MT-32, GM, XG, GS, GM2 and etc.), while exposing simple yet powerful interfaces for developers to build upon.

With Octavia, no longer will you worry about either standard compliance or non-standard environment extensions. Just focus on building what's important, be it visualizers, state browsers, event routers or even realtime event translators, Octavia's got your back. Feel free to test Octavia's capabilities with all available demos.

Why Octavia?

  • Free, libre and open-source, licensed under GNU LGPL v3.0.
  • Available as web-compliant JS (standard ESM; browser and Deno) with TypeScript declarations.
  • Beyond a capable runtime, standard ECMAScript, and web-compliance, assumes nothing about the environment.
  • Comparatively stringent compliance of existing established standards.
  • Developed with Firefox and open Web in mind, not just bootlicking Chromium and V8. Independent browsers like Servo and Ladybird are irregularly tested as well.
  • No modification required to run in hardened forks of browsers, like Tor Browser, Cromite and LibreWolf.

Octavia Lyre

  • Supports 16 ports, 256 channels, 768-voice polyphony maximum. More than you'll ever need.
  • Keep your focus on building what matters, as Lyre behaves like a real MIDI module, taking over the heavy-lifting for you.
  • Built-in support for multiple plug-in cards, various established standards, and tons of other devices, with instrument data backed by Octavia Scroll.
  • Emits warnings when MIDI programming errors are spotted, reducing chances of faulty programming.

Octavia MICC

  • Your parser and serialiser should not fight against or omit information from you, while assisting and leaving you alone whenever needed. We endured the pain for years before, now you shouldn't have to.
  • You choose to either keep close to the metal or get the abstraction you need. Unlike most MIDI parser libraries, this library doesn't alienate either.
  • (WIP) Relatively hands-off text decoding and port allocation. No need to bother with headaches like this when you don't want to, unlike most MIDI parser libraries.
  • (WIP) Unlike most music-related parser libraries, don't get restricted by synchronous buffers, MIDI 1.0, Standard MIDI Files, or even MIDI. The world is vast, your project's coverage should be too without much headache.
  • (WIP) Don't stop at merely parsing, get serialisation and conversion as well, mostly for free!

Environment tests

Don't believe our claims regarding environment neutrality? Hope this section changes your mind!

Browsers

This section is updated manually and irregularly. Automated full coverage test is not yet fully possible, especially for Epiphany and Ladybird.

Browser Engines Status Version
Chromium V8 (Blink) Supported 154
Epiphany JavaScriptCore (WebKitGTK) Supported 48.5
Firefox SpiderMonkey (Gecko) Supported 153 ESR
Ladybird LibJS (LibWeb) Supported Pre-alpha 20260922
Servo SpiderMonkey (Servo) Supported 0.5.0

Runtimes

  • Node.js is pinned to the newer version between the latest LTS shipped by Debian stable and the latest version supporting `import.meta.main.
  • Deno is pinned to the latest stable release on version 2.
  • Tests for all other JS runtimes are run on their respective latest stable release.

Validate multiple runtimes

All supported runtimes listed below have their output verified to be identical to each other, without requiring compatibility layers for APIs of a specific runtime. Node.js requires at least the Fly Leaf conformance script (vergilius.mjs) to function, check Fly Leaf for details.

Component Deno Ende Bun Node.js 22 LTS
chord.mjs βœ“ βœ“ βœ“ βœ“
Lyre v2 βœ“ βœ“ βœ“ βœ“
MICC βœ“ βœ“ βœ“ βœ“
  • Certain runtimes do not implement standard web features, as such they require the Fly Leaf initialiser, the Fly Leaf loader, or web API polyfills to function.
    • Ant.js currently lacks decoding support for various legacy text encodings, causing MICC to crash upon load.
  • Lyre v2 will be retired before Octavia 0.6, which will be replaced by Lyre v3.

Supported targets

Octavia offers support to a wide range of targets, most of them being either GM-compliant or having strong historical importance. Read the support page for more information.

To have a general idea of how MIDI is implemented, refer to the MIDI Implementation Chart and Supported SysEx instructions.

Dev talks

We've been hosting places to handle development discussions! If you don't have a GitHub account, or just prefer to report bugs or give suggestions in a more casual way, feel free to chat with us with links below!

Credits

Please read CREDITS.md.

API & more

Please read the documentation.

Examples

If it exists, please check out the /examples/ directory.

Contribute

You can help with Octavia's development, by doing any of the following, or more...

  • Test Octavia, whether under production environment or not.
  • Write anything utilizing Octavia's API.
  • Report any bugs you find.
  • Submit feature requests.
  • Participate in programming (read the docs for further info).
  • Reward the developers some donation.
  • Spread the word about Octavia.

Stargazers over time

Stargazers over time

About

🎻 State tracker, file parser, file serialiser. Event-driven multi-standard MIDI tool chain with insane support coverage.

Topics

Resources

Stars

63 stars

Watchers

3 watching

Forks

Releases

Packages

Used by

Contributors

Languages