Support pipewire as host

.github/workflows/platforms.yml

@@ -24,15 +24,15 @@ on:
 
 env:
   # MSRV varies by backend due to platform-specific dependencies
-  MSRV_AAUDIO: "1.82"
-  MSRV_ALSA: "1.82"
+  MSRV_AAUDIO: "1.85"
+  MSRV_ALSA: "1.85"
   MSRV_COREAUDIO: "1.80"
   MSRV_JACK: "1.82"
   MSRV_WASIP1: "1.78"
   MSRV_WASM: "1.82"
   MSRV_WINDOWS: "1.82"
 
-  PACKAGES_LINUX: libasound2-dev libjack-jackd2-dev libjack-jackd2-0 libdbus-1-dev
+  PACKAGES_LINUX: libasound2-dev libjack-jackd2-dev libjack-jackd2-0 libdbus-1-dev libpipewire-0.3-dev
 
   ANDROID_COMPILE_SDK: "30"
   ANDROID_BUILD_TOOLS: "30.0.3"
@@ -94,10 +94,10 @@ jobs:
         run: cargo +${{ env.MSRV_ALSA }} check --examples --no-default-features --workspace --verbose
 
       - name: Run tests (all features)
-        run: cargo +${{ steps.msrv.outputs.all-features }} test --all-features --workspace --verbose
+        run: cargo +${{ steps.msrv.outputs.all-features }} test --features=jack --workspace --verbose
 
       - name: Check examples (all features)
-        run: cargo +${{ steps.msrv.outputs.all-features }} check --examples --all-features --workspace --verbose
+        run: cargo +${{ steps.msrv.outputs.all-features }} check --examples --features=jack --workspace --verbose
 
   # Linux ARMv7 (cross-compilation)
   linux-armv7:
@@ -150,10 +150,10 @@ jobs:
         run: cross +${{ env.MSRV_ALSA }} test --no-default-features --workspace --verbose --target ${{ env.TARGET }}
 
       - name: Run tests (all features)
-        run: cross +${{ steps.msrv.outputs.all-features }} test --all-features --workspace --verbose --target ${{ env.TARGET }}
+        run: cross +${{ steps.msrv.outputs.all-features }} test --features=jack --workspace --verbose --target ${{ env.TARGET }}
 
       - name: Check examples (all features)
-        run: cross +${{ steps.msrv.outputs.all-features }} test --all-features --workspace --verbose --target ${{ env.TARGET }}
+        run: cross +${{ steps.msrv.outputs.all-features }} test --features=jack --workspace --verbose --target ${{ env.TARGET }}
 
   # Windows (x86_64 and i686)
   windows:

.github/workflows/quality.yml

@@ -92,7 +92,7 @@ jobs:
         if: runner.os == 'Linux'
         uses: awalsh128/cache-apt-pkgs-action@latest
         with:
-          packages: libasound2-dev libjack-jackd2-dev libjack-jackd2-0 libdbus-1-dev
+          packages: libasound2-dev libjack-jackd2-dev libjack-jackd2-0 libdbus-1-dev libpipewire-0.3-dev
 
       - name: Setup ASIO SDK
         if: runner.os == 'Windows'
@@ -128,7 +128,7 @@ jobs:
       - name: Cache Linux audio packages
         uses: awalsh128/cache-apt-pkgs-action@latest
         with:
-          packages: libasound2-dev libjack-jackd2-dev libjack-jackd2-0 libdbus-1-dev
+          packages: libasound2-dev libjack-jackd2-dev libjack-jackd2-0 libdbus-1-dev libpipewire-0.3-dev
 
       - name: Install Rust toolchain
         uses: dtolnay/rust-toolchain@nightly

Cargo.toml

@@ -25,6 +25,7 @@ asio = [
 # Platform: Linux, DragonFly BSD, FreeBSD, NetBSD, macOS, Windows
 # Note: JACK must be installed separately on all platforms
 jack = ["dep:jack"]
+pipewire = ["dep:pipewire"]
 
 # WebAssembly backend using wasm-bindgen
 # Enables the Web Audio API backend for browser-based audio
@@ -53,6 +54,8 @@ audioworklet = [
 # Platform: All platforms
 custom = []
 
+default = []
+
 [dependencies]
 dasp_sample = "0.11"
 
@@ -89,6 +92,7 @@ alsa = "0.11"
 libc = "0.2"
 audio_thread_priority = { version = "0.34", optional = true }
 jack = { version = "0.13", optional = true }
+pipewire = { version = "0.9.2", optional = true, features = ["v0_3_44"]}
 
 [target.'cfg(target_vendor = "apple")'.dependencies]
 mach2 = "0.5"

Cross.toml

@@ -2,6 +2,4 @@
 dockerfile = "Dockerfile"
 
 [target.armv7-unknown-linux-gnueabihf.env]
-passthrough = [
-    "RUSTFLAGS",
-]
+passthrough = ["RUSTFLAGS"]

Dockerfile

@@ -7,4 +7,5 @@ ENV PKG_CONFIG_PATH=/usr/lib/arm-linux-gnueabihf/pkgconfig/
 RUN dpkg --add-architecture armhf && \
     apt-get update && \
     apt-get install libasound2-dev:armhf -y && \
-    apt-get install libjack-jackd2-dev:armhf libjack-jackd2-0:armhf -y \
+    apt-get install libjack-jackd2-dev:armhf libjack-jackd2-0:armhf -y
+# TODO: now the cross-rs is based on ubuntu:20.04, so it does not contain pipewire-0.3-dev

_typos.toml

@@ -0,0 +1,2 @@
+[default.extend-words]
+datas = "datas"

examples/beep.rs

@@ -37,6 +37,19 @@ struct Opt {
     #[arg(short, long)]
     #[allow(dead_code)]
     jack: bool,
+    /// Use the pipewire host
+    #[cfg(all(
+        any(
+            target_os = "linux",
+            target_os = "dragonfly",
+            target_os = "freebsd",
+            target_os = "netbsd"
+        ),
+        feature = "pipewire"
+    ))]
+    #[arg(short, long)]
+    #[allow(dead_code)]
+    pipewire: bool,
 }
 
 fn main() -> anyhow::Result<()> {
@@ -64,6 +77,28 @@ fn main() -> anyhow::Result<()> {
     } else {
         cpal::default_host()
     };
+    // Conditionally compile with jack if the feature is specified.
+    #[cfg(all(
+        any(
+            target_os = "linux",
+            target_os = "dragonfly",
+            target_os = "freebsd",
+            target_os = "netbsd"
+        ),
+        feature = "pipewire"
+    ))]
+    // Manually check for flags. Can be passed through cargo with -- e.g.
+    // cargo run --release --example beep --features jack -- --jack
+    let host = if opt.pipewire {
+        cpal::host_from_id(cpal::available_hosts()
+            .into_iter()
+            .find(|id| *id == cpal::HostId::PipeWire)
+            .expect(
+                "make sure --features pipewire is specified. only works on OSes where jack is available",
+            )).expect("jack host unavailable")
+    } else {
+        cpal::default_host()
+    };
 
     #[cfg(any(
         not(any(
@@ -72,7 +107,7 @@ fn main() -> anyhow::Result<()> {
             target_os = "freebsd",
             target_os = "netbsd"
         )),
-        not(feature = "jack")
+        not(any(feature = "jack", feature = "pipewire"))
     ))]
     let host = cpal::default_host();
 

examples/record_wav.rs

@@ -33,6 +33,19 @@ struct Opt {
     #[arg(short, long)]
     #[allow(dead_code)]
     jack: bool,
+    /// Use the pipewire host
+    #[cfg(all(
+        any(
+            target_os = "linux",
+            target_os = "dragonfly",
+            target_os = "freebsd",
+            target_os = "netbsd"
+        ),
+        feature = "pipewire"
+    ))]
+    #[arg(short, long)]
+    #[allow(dead_code)]
+    pipewire: bool,
 }
 
 fn main() -> Result<(), anyhow::Error> {
@@ -49,7 +62,7 @@ fn main() -> Result<(), anyhow::Error> {
         feature = "jack"
     ))]
     // Manually check for flags. Can be passed through cargo with -- e.g.
-    // cargo run --release --example beep --features jack -- --jack
+    // cargo run --release --example record_wav --features jack -- --jack
     let host = if opt.jack {
         cpal::host_from_id(cpal::available_hosts()
             .into_iter()
@@ -61,14 +74,36 @@ fn main() -> Result<(), anyhow::Error> {
         cpal::default_host()
     };
 
+    // Conditionally compile with jack if the feature is specified.
+    #[cfg(all(
+        any(
+            target_os = "linux",
+            target_os = "dragonfly",
+            target_os = "freebsd",
+            target_os = "netbsd"
+        ),
+        feature = "pipewire"
+    ))]
+    // Manually check for flags. Can be passed through cargo with -- e.g.
+    // cargo run --release --example record_wav --features pipewire -- -- pipewire
+    let host = if opt.pipewire {
+        cpal::host_from_id(cpal::available_hosts()
+            .into_iter()
+            .find(|id| *id == cpal::HostId::PipeWire)
+            .expect(
+                "make sure --features pipewire is specified. only works on OSes where jack is available",
+            )).expect("jack host unavailable")
+    } else {
+        cpal::default_host()
+    };
     #[cfg(any(
         not(any(
             target_os = "linux",
             target_os = "dragonfly",
             target_os = "freebsd",
             target_os = "netbsd"
         )),
-        not(feature = "jack")
+        not(any(feature = "jack", feature = "pipewire"))
     ))]
     let host = cpal::default_host();
 

src/host/mod.rs

@@ -31,6 +31,11 @@ pub(crate) mod emscripten;
     )
 ))]
 pub(crate) mod jack;
+#[cfg(all(
+    any(target_os = "linux", target_os = "dragonfly", target_os = "freebsd"),
+    feature = "pipewire"
+))]
+pub(crate) mod pipewire;
 #[cfg(windows)]
 pub(crate) mod wasapi;
 #[cfg(all(target_arch = "wasm32", feature = "wasm-bindgen"))]