RemiAudio is a collection of audio format I/O routines, codecs, and processors/effects written entirely in Crystal.

This is still semi-early in development, so the API will likely experience frequent changes. Expect a few bugs. See the NOTES file in the repostory's root directory for current notes about the library and a few to-do items.

Wanna support Remilia? Buy me a coffee on Ko-Fi, or support me through Liberapay.

Buy Me a Coffee at ko-fi.com Donate using Liberapay


A list of supported features and planned features.

How do I get set up?

Add this to your application's shard.yml:

    fossil: https://chiselapp.com/user/MistressRemilia/repository/remiaudio

You will need Fossil installed to clone this repo and the dependency. You will also need Shards v0.17.1 or later. If you have an earlier version of Shards, you will need to to build the latest version manually.


API documentation can be found here: https://remilia.sdf.org/programming/docs/remiaudio

Version Control

RemiAudio sources are managed using Fossil, a distributed version control system. The Fossil repository contains the urtext, tickets, and wiki.

If you are reading this on GitLab or some other Git repository or service, then you are looking at a mirror. The names of check-ins and other artifacts in a Git mirror are different from the official names for those objects. The official names for check-ins are found in a footer on the check-in comment for authorized mirrors. The official check-in name can also be seen in the manifest.uuid file in the root of the tree. Always use the official name, not the Git-name, when communicating about a RemiAudio check-in.


Help Wanted/Known Issues

Style info

I use a somewhat non-standard style for my code.

How do I contribute?

  1. Go to https://chiselapp.com/user/MistressRemilia/repository/remiaudio/ and clone the Fossil repository.
  2. Create a new branch for your feature.
  3. Push locally to the new branch.
  4. Create a bundle with Fossil that contains your changes.
  5. Get in contact with me.


Links and Licenses

RemiAudio itself is mostly under the GNU Affero General Public License version 3, except for the items listed above.