Skip to content

Latest commit

 

History

History
113 lines (76 loc) · 3.02 KB

README.md

File metadata and controls

113 lines (76 loc) · 3.02 KB
Raw

muslib

Rust library for music synthesis and processing, inspired by Essentia.

It provides a few simple algorithms and utilities:

  • tonal analysis with harmonic pitch class profile -- HPCP
  • inverse fast Fourier transform -- IFFT
  • short-time Fourier transform -- STFT
  • simple mixer to create mono tracks
  • synthesizer for simple waveforms

Installation

You can download pre-built binaries from the releases page. Otherwise see build instructions for more details.

The Rust crate is available through crates.io. You can add it with a simple:

$ cargo add muslib

There is also a Python package available on pypi.org. You can install it with a simple:

$ pip install muslib

Usage

This project provides a Rust library that can be used in other Rust projects or from Python code with our PyO3 bindings.

See docs for a more detailed documentation and examples to learn how you could use this project in your own code.

Development

build

You can use a simple cargo command to compile a release binary. The output will be in the target/release directory.

$ cargo build --release

To compile a Python wheel use maturin.

$ maturin build

All project dependencies are listed in the Cargo.toml file.

docs

You can generate docs with a simple cargo command. The output will be in the target/doc directory.

$ cargo doc

The documentation should also be available through docs.rs.

tests

$ cargo test

TODO: create build CI and link it here

examples

You can run Rust examples from the examples directory with:

$ cargo run --example [name] [args]

You will also find Python examples there, including those comparing the usage of muslib and Essentia for simple tasks.

Some test scripts and helpers that were often run by hand during development are also there.

alternatives

Other interesting Rust projects for audio DSP:

license

In the same spirit as Essentia, this project is licensed under AGPL-3.0.

Copyright (C) 2023 wykwit

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as
published by the Free Software Foundation, either version 3 of the
License, or (at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.