Rust JACK

License: MIT

crates.io docs.rs

Build Status

Nice Rust bindings for JACK Audio Connection Kit

Documentation for Master

Check out the examples directory for usage.

Crates

Stable

toml [dependencies] jack = "0.6"

Master

toml [dependencies] jack = { git = "https://github.com/RustAudio/rust-jack.git" }

Completeness

For details on which functions from the JACK headers have been implemented, see ffi_completeness.md.

More high-level, creating clients, creating/reading/writing/connecting ports, audio, and midi are supported.

Missing categories include, JACK threading, synchronous processing, transport and control functionality.

Running

Testing

Testing requires setting up a dummy server and running the tests using a single thread.

bash $ # Set up a dummy server for tests. $ ./dummy_jack_server.sh $ # Run tests with limited concurrency. $ RUST_TEST_THREADS=1 cargo test

Note: We use a single thread for tests since too multiple client instantiations in short periods of time cause the JACK server to become flaky.

Possible Issues

If the tests are failing, a possible gotcha may be timing issues.

  1. Increase the value used by sleep_on_test in client/common.rs.

Another case is that libjack may be broken on your setup. Try switching between libjack and libjack2 (they have the same API and libjack2 isn't necessarily newer than libjack), or using a different version.

"C" & Rust API differences

C JACK API

Main Page