Dynamically load JACK. #162

wmedrano · 2022-02-05T04:38:08Z

Resolves #159

jack-sys/src/lib.rs

Be-ing · 2022-02-05T14:20:23Z

src/client/callbacks.rs

-        j::jack_set_buffer_size_callback(client, Some(buffer_size::<N, P>), data_ptr);
-        j::jack_set_sample_rate_callback(client, Some(sample_rate::<N, P>), data_ptr);
-        j::jack_set_client_registration_callback(
+        (LIB.jack_set_thread_init_callback)(client, Some(thread_init_callback::<N, P>), data_ptr);


I'm confused by this. The dlib documentation says you need to use the ffi_dispatch! macro for this.

You don't really need it. I could update all the callers to enable static and dynamic dispatch.

Full disclosure: I couldn't get the macro to work.

Other thing the dlib library seemed not to work well is specifying both statics and functions in the same external_library! definition. Even the README's example does not compile.

Not being able to link directly defeats the purpose of using dlopen instead of using libloading directly.

Fixed ffi_dispatch!. The issues I ran into were lack of support for trailing commas and no support for functions that don't have any arguments. The latter cases were handled manually, luckily there were only a couple of them.

Great, thanks for taking care of that. I suggest reporting those issues upstream.

jack-sys/Cargo.toml

Cargo.toml

Be-ing · 2022-02-05T19:17:41Z

Two big issues with this branch currently:

There is no option to link libjack at build time. Perhaps this could be an issue for Linux distros? I'm not sure. It does defeat the purpose of using dlopen though.
It searches for libjack.so at runtime which is provided by {pipewire-}jack-audio-connection-kit-devel on Fedora. libjack.so.0 is the file provided by the non-devel packages.

wmedrano · 2022-02-05T20:38:51Z

Updated to:

Allow static linking or dynamic through dlopen feature.
Use ffi_dispatch
Dynamically load from libjack.so.0.

Be-ing · 2022-02-05T20:39:52Z

jack-sys/src/lib.rs

+pub const JACK_LIB: &'static str = "libjack.dll";
+
+#[cfg(not(windows))]
+pub const JACK_LIB: &'static str = "libjack.so.0\0";


On macOS, it is libjack.0.dylib: https://github.com/jackaudio/jack2/blob/852ba2b8ebc944865e75d8eb5d4550d408772f3b/common/JackWeakAPI.c#L50

Cargo.toml

Be-ing · 2022-02-05T21:44:40Z

This is working on Fedora 35 now.

Using dlopen feature:

sudo dnf remove pipewire-jack-audio-connection-kit
Build application
jack::Client::new returns Err(LoadLibraryError("Could not open the requested library: libjack.so.0: cannot open shared object file: No such file or directory")) as expected.
sudo dnf install pipewire-jack-audio-connection-kit (without -devel package)
Application works

Without dlopen feature:

sudo dnf remove pipewire-jack-audio-connection-kit
Build application
Application build fails to link jack as expected.
sudo dnf install pipewire-jack-audio-connection-kit-devel
Build application
Application works

Be-ing · 2022-02-05T22:08:24Z

I made a PR to fix the platform-specific library names: #164. It is working on Linux. I will test it on macOS and Windows.

* jack-sys: fix platform-specific dynamic library names * jack-sys: do not use pkg-config with dlopen feature If there happens to be a pkgconfig file but no libjack, downstream applications may fail to link.

Be-ing · 2022-02-06T00:22:51Z

I tested #164 on macOS (x86-64) and Windows (x86-64 in QEMU-KVM). macOS is definitely working with and without the dlopen feature. On Windows, I got my application to run with dlopen and I think it connected to the JACK server. I wasn't able to really test if it was functional because my application's GUI depends on OpenGL which I guess wasn't available in the VM and I don't feel like investing the effort to get that working right now. However, when I commented out my application's GUI, the application did run. Curiously QJackCtl froze while my application was running, but I don't know if that's some artifact of virtualization or what. What matters for the sake of this PR is that it linked and the application loaded libjack without crashing. Without dlopen I was not able to get the application to link on Windows.

So I think this is ready to merge!

Be-ing · 2022-02-06T19:56:26Z

Yaaaay! I'll make a PR to document the new behavior.

Be-ing · 2022-02-11T04:42:54Z

I got cross compiling to x86_64-pc-windows-gnu, x86_64-apple-darwin, and aarch64-apple-darwin from x86-64 Linux working! For macOS I had to use osxcross following this guide. So now it's possible to build cross platform JACK applications from Linux without even needing to build or link C! 🚀

wmedrano added 12 commits February 4, 2022 20:09

Use dynamic loading.

055ecf2

Dynamically load JACK.

8978061

Fix metadata feature.

5b7be34

Remove symbol missing from CI.

4741d69

Remove more symbols.

b54578e

another one.

1d24284

another one.

561eb2a

another one.

c5a7780

another one.

75b7bcd

another one.

aa3f6f5

another one.

c6d854c

Update version.

74eefdf

Be-ing reviewed Feb 5, 2022

View reviewed changes

jack-sys/src/lib.rs Show resolved Hide resolved

Be-ing reviewed Feb 5, 2022

View reviewed changes

jack-sys/src/lib.rs Show resolved Hide resolved

Be-ing reviewed Feb 5, 2022

View reviewed changes

jack-sys/src/lib.rs Outdated Show resolved Hide resolved

Be-ing reviewed Feb 5, 2022

View reviewed changes

jack-sys/src/lib.rs Show resolved Hide resolved

Be-ing reviewed Feb 5, 2022

View reviewed changes

Use internal copy of lib.

22d5e73

Be-ing reviewed Feb 5, 2022

View reviewed changes

jack-sys/Cargo.toml Outdated Show resolved Hide resolved

Be-ing reviewed Feb 5, 2022

View reviewed changes

Cargo.toml Outdated Show resolved Hide resolved

wmedrano added 4 commits February 5, 2022 12:18

Use ffi_dispatch!

194e820

Fix metadata,dlopen

c3c1d10

fix

08f170a

Test multiple configurations.

6d00f98

Be-ing reviewed Feb 5, 2022

View reviewed changes

Split tests.

1d3cddc

Be-ing reviewed Feb 5, 2022

View reviewed changes

Cargo.toml Outdated Show resolved Hide resolved

Remove redundant test.

b949b25

jack-sys: fix platform-specific dynamic library names (#164)

7ab874e

* jack-sys: fix platform-specific dynamic library names * jack-sys: do not use pkg-config with dlopen feature If there happens to be a pkgconfig file but no libjack, downstream applications may fail to link.

wmedrano added 3 commits February 6, 2022 09:20

Fix build... IDK how macro broke overnight.

e319b17

Make dlopen default

40508c4

Update docs.

9e97a3d

wmedrano merged commit cd561d9 into main Feb 6, 2022

wmedrano deleted the dlib branch October 30, 2022 04:55

Uh oh!

Dynamically load JACK. #162

Dynamically load JACK. #162

Uh oh!

Conversation

wmedrano commented Feb 5, 2022

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Be-ing Feb 5, 2022

Choose a reason for hiding this comment

Uh oh!

wmedrano Feb 5, 2022

Choose a reason for hiding this comment

Uh oh!

wmedrano Feb 5, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Be-ing Feb 5, 2022

Choose a reason for hiding this comment

Uh oh!

wmedrano Feb 5, 2022

Choose a reason for hiding this comment

Uh oh!

Be-ing Feb 5, 2022

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Be-ing commented Feb 5, 2022

Uh oh!

wmedrano commented Feb 5, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Be-ing Feb 5, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Be-ing commented Feb 5, 2022

Uh oh!

Be-ing commented Feb 5, 2022

Uh oh!

Be-ing commented Feb 6, 2022

Uh oh!

Be-ing commented Feb 6, 2022

Uh oh!

Be-ing commented Feb 11, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

wmedrano Feb 5, 2022 •

edited

Loading

wmedrano commented Feb 5, 2022 •

edited

Loading

Be-ing Feb 5, 2022 •

edited

Loading

Be-ing commented Feb 11, 2022 •

edited

Loading