Rust JACK

Rust bindings for JACK Audio Connection Kit.

Check out the examples directory for usage.

Crates

[dependencies]
jack = "0.6"

Windows

Install JACK from the official website. Link the installed library in your rust code. For example:

#[cfg(target_os = "windows")]
#[link(name = "C:/Program Files/JACK2/lib/libjack64")]
extern "C" {}

Running

• libjack is required. Consult your package manager or the official website.

• The general workflow for a JACK application is to start up a JACK daemon and connect the client to it. qjackctl is a convinient way to configure and bring up a JACK server through a GUI.

• JACK FAQ

Testing

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

# 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

• String lengths in the "C" API include the NULL character while these Rust bindings do not. generally rust_size(x) = c_size(x) - 1.
• "C" bindings require functions to be registered while Rust bindings register an object with a trait.
• jack_on_shutdown has been removed, uses only jack_on_info_shutdown.
• Rust enums vs C enums
• Rust bitflags vs C integers used as flags
• deprecated JACK functions are not used/implemented in Rust bindings

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.

C JACK API

API documentation