Dynamically load JACK. (RustAudio#162)

Makes it easier to compile, especially for Windows.

Also updated tests to build more feature combinations.

Co-authored-by: Be <[email protected]>

Author: wmedrano

.github/workflows/rust.yml

@@ -12,17 +12,34 @@ env:
 jobs:
   build:
     runs-on: ubuntu-latest
-
     steps:
       - name: Checkout
         uses: actions/checkout@v2
       - name: Install dependencies
         run: sudo apt update && sudo apt install jackd libjack0 libjack-dev
+
+      # This is required for the tests, but we start it earlier since it may
+      # take a while to initialize.
       - name: Start dummy JACK server
         run: jackd -r -ddummy -r44100 -p1024 &
-      - name: Lint
-        run: cargo clippy --all-targets --all-features -- -D clippy::all
-      - name: Build
-        run: cargo build --verbose
+
+      - name: Lint (No Features)
+        run: cargo clippy --all-targets --no-default-features -- -D clippy::all
+      - name: Lint (All Features)
+        run: cargo clippy --all-targets --no-default-features --features dlopen,metadata -- -D clippy::all
+      - name: Lint (dlopen)
+        run: cargo clippy --all-targets --no-default-features --features dlopen -- -D clippy::all
+      - name: Lint (metadata)
+        run: cargo clippy --all-targets --no-default-features --features metadata -- -D clippy::all
+
+      - name: Build (No Features)
+        run: cargo build --verbose --no-default-features
+      - name: Build (All Features)
+        run: cargo build --verbose --no-default-features --features dlopen,metadata
+      - name: Build (dlopen)
+        run: cargo build --verbose --no-default-features --features dlopen
+      - name: Build (metadata)
+        run: cargo build --verbose --no-default-features --features metadata
+
       - name: Run Tests
-        run: RUST_TEST_THREADS=1 cargo test --verbose
+        run: RUST_TEST_THREADS=1 cargo test --verbose --all-features

CHANGELOG

@@ -1,12 +1,16 @@
 # Changelog
 
-## HEAD
-- Updated dependencies to latest as of 2021/11/17.
+## 0.9.0
+
+- Jack library can be loaded dynamically from libjack.so.0 or libjack.dll.
+- Updated dependencies to latest as of 2022/02/05.
 
 ## 0.8.2
+
 - `MidiIter` is now `Sync`.
 
 ## 0.8.1
+
 - `AsyncClient` and `Client` are `Sync`.
 
 ## 0.8.0

Cargo.toml

@@ -8,7 +8,7 @@ license = "MIT"
 name = "jack"
 readme = "README.md"
 repository = "https://github.com/RustAudio/rust-jack"
-version = "0.8.4"
+version = "0.9.0"
 
 [dependencies]
 bitflags = "1"
@@ -22,5 +22,6 @@ log = "0.4"
 crossbeam-channel = "0.5"
 
 [features]
-default = []
+default = ["dlopen"]
+dlopen = ["jack-sys/dlopen"]
 metadata = []

README.md

@@ -16,27 +16,21 @@ Check out the `examples` directory for usage.
 
 ```toml
 [dependencies]
-jack = "0.8"
+jack = "0.9"
 ```
 
 ### Windows
 
 Install `JACK` from the [official website](http://jackaudio.org/downloads/).
-Link the installed library in your rust code. For example:
-
-```rust
-#[cfg(target_os = "windows")]
-#[link(name = "C:/Program Files/JACK2/lib/libjack64")]
-extern "C" {}
-```
+libjack64.dll (or libjack.dll for 32bit) is required for Windows to work.
 
 ## Running
 
-* `libjack` is required. Consult your package manager or the [official](http://jackaudio.org/downloads/) website.
+- `libjack` is required. Consult your package manager or the [official](http://jackaudio.org/downloads/) website.
 
-* The general workflow for a JACK application is to start up a JACK daemon and connect the client to it. [qjackctl](http://qjackctl.sourceforge.net/) is a convinient way to configure and bring up a JACK server through a GUI.
+- The general workflow for a JACK application is to start up a JACK daemon and connect the client to it. [qjackctl](http://qjackctl.sourceforge.net/) is a convinient way to configure and bring up a JACK server through a GUI.
 
-* [JACK FAQ](http://jackaudio.org/faq/)
+- [JACK FAQ](http://jackaudio.org/faq/)
 
 ## Testing
 
@@ -59,29 +53,6 @@ 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
+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](https://jackaudio.org/api/)

jack-sys/Cargo.toml

@@ -6,7 +6,7 @@ license = "MIT OR Apache-2.0"
 links = "jack"
 name = "jack-sys"
 repository = "https://github.com/RustAudio/rust-jack/tree/main/jack-sys"
-version = "0.3.0"
+version = "0.3.3"
 
 [dependencies]
 dlib = "0.5"

jack-sys/README.md

@@ -1,7 +1,11 @@
-# jack-sys 
+# jack-sys
 
 [![crates.io](https://img.shields.io/crates/v/jack-sys.svg)](https://crates.io/crates/jack-sys)
 
 Low-level bindings for the [JACK Audio Connection Kit](http://jackaudio.org/). Generated using [rust-bindgen](https://github.com/rust-lang/rust-bindgen).
 
 Requires JACK to be installed on the system.
+
+## C JACK API
+
+[API documentation](https://jackaudio.org/api/)

jack-sys/build.rs

@@ -3,5 +3,6 @@ fn main() {
     // Refer to https://github.com/RustAudio/rust-jack/issues/142 for details.
     // Do not unwrap this because linking might still work if pkg-config is
     // not installed, for example on Windows.
+    #[cfg(not(feature = "dlopen"))]
     let _ = pkg_config::probe_library("jack");
 }