Merge branch 'main' into dependabot/cargo/ndarray-0.17.1

Author: SolarLiner

.github/workflows/CI.yml

@@ -13,7 +13,7 @@ jobs:
   fmt:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v5
+    - uses: actions/checkout@v6
     - name: Install dependencies (Linux)
       run: sudo apt install libasound2-dev libspa-0.2-dev libpipewire-0.3-dev
     - name: Install Rust 1.88
@@ -31,7 +31,7 @@ jobs:
         os: [windows, ubuntu, macos]
     runs-on: ${{ matrix.os }}-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
       - name: Install dependencies (Linux)
         if: ${{ matrix.os == 'ubuntu' }}
         run: sudo apt install libasound2-dev libspa-0.2-dev libpipewire-0.3-dev
@@ -61,7 +61,7 @@ jobs:
             feature-pipewire: true
     runs-on: ${{ matrix.os }}
     steps:
-    - uses: actions/checkout@v5
+    - uses: actions/checkout@v6
     - name: Install dependencies (Linux)
       if: ${{ matrix.os == 'ubuntu-latest' }}
       run: sudo apt install libasound2-dev libspa-0.2-dev libpipewire-0.3-dev

.github/workflows/build_nix.yml

@@ -10,7 +10,7 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
       - uses: cachix/install-nix-action@v31
       - name: Building package
         run: nix build

.github/workflows/documentation.yml

@@ -18,15 +18,15 @@ jobs:
         run: |
           sudo apt-get update
           sudo apt-get install -y libasound2-dev libspa-0.2-dev libpipewire-0.3-dev
-      - uses: actions/cache@v4
+      - uses: actions/cache@v5
         with:
           path: |
             ~/.cargo/registry/index/
             ~/.cargo/registry/cache/
             ~/.cargo/git/db/
             target/
           key: ${{ matrix.name }}-${{ matrix.cross-target }}
-      - uses: actions/checkout@v5
+      - uses: actions/checkout@v6
       - name: Fetch all git history
         run: git fetch --force --prune --tags --unshallow
       - name: Set up Rust toolchain

Cargo.lock

@@ -9,17 +9,17 @@ license = "MIT"
 bitflags = "2.10.0"
 duplicate = "2.0.1"
 fixed-resample = "0.9.2"
-log = { version = "0.4.28", features = ["kv"] }
+log = { version = "0.4.29", features = ["kv"] }
 ndarray = "0.17.1"
 oneshot = "0.1.11"
 rtrb = "0.3.2"
 thiserror = "2.0.17"
-zerocopy = { version = "0.8.27", optional = true }
+zerocopy = { version = "0.8.31", optional = true }
 
 [dev-dependencies]
 anyhow = "1.0.100"
 env_logger = "0.11.8"
-indicatif = "0.18.2"
+indicatif = "0.18.3"
 
 [build-dependencies]
 cfg_aliases = "0.2.1"
@@ -29,7 +29,7 @@ pipewire = ["dep:pipewire", "dep:libspa", "dep:libspa-sys", "dep:zerocopy"]
 
 [target.'cfg(any(target_os = "linux", target_os = "dragonfly", target_os = "freebsd", target_os = "netbsd"))'.dependencies]
 alsa = "0.10.0"
-libc = "0.2.177"
+libc = "0.2.178"
 libspa = { version = "0.8.0", optional = true }
 libspa-sys = { version = "0.8.0", optional = true }
 nix = "0.30.1"

Cargo.toml

@@ -351,6 +351,8 @@ where
         Some(Self { storage })
     }
 
+    /// Create an audio buffer reference from non-interleaved data. This does *not* copy the data,
+    /// but creates a view over it, so that it can be accessed as any other audio buffer.
     pub fn from_noninterleaved(data: &'a [T], channels: usize) -> Option<Self> {
         let buffer_size = data.len() / channels;
         let storage = ArrayView2::from_shape((channels, buffer_size), data).ok()?;
@@ -373,6 +375,12 @@ impl<'a, T: 'a> AudioMut<'a, T> {
         Some(Self { storage })
     }
 
+    /// Create an audio buffer mutable reference from interleaved data. This does *not* copy the
+    /// data, but creates a view over it, so that it can be accessed as any other audio buffer.
+    ///
+    /// Writes to the resulting buffer directly map to the provided slice, and asking an
+    /// interleaved view out of the resulting buffer (with [`AudioBufferBase::as_interleaved`])
+    /// means the same slice is returned.
     pub fn from_noninterleaved_mut(data: &'a mut [T], channels: usize) -> Option<Self> {
         let buffer_size = data.len() / channels;
         let storage = ArrayViewMut2::from_shape((channels, buffer_size), data).ok()?;

src/audio_buffer.rs

@@ -49,14 +49,14 @@ impl<Callback: 'static + Send> AlsaStream<Callback> {
                 let mut poll_descriptors = {
                     let mut buf = vec![rx.as_pollfd()];
                     let num_descriptors = device.pcm.count();
-                    buf.extend(
-                        std::iter::repeat(libc::pollfd {
+                    buf.extend(std::iter::repeat_n(
+                        libc::pollfd {
                             fd: 0,
                             events: 0,
                             revents: 0,
-                        })
-                        .take(num_descriptors),
-                    );
+                        },
+                        num_descriptors,
+                    ));
                     buf
                 };
                 let (hwp, _, io) = device.apply_config(&stream_config)?;
@@ -70,7 +70,7 @@ impl<Callback: 'static + Send> AlsaStream<Callback> {
                 let stream_config = StreamConfig {
                     samplerate,
                     channels: ChannelMap32::default()
-                        .with_indices(std::iter::repeat(1).take(num_channels)),
+                        .with_indices(std::iter::repeat_n(1, num_channels)),
                     buffer_size_range: (Some(period_size), Some(period_size)),
                     exclusive: false,
                 };

src/backends/alsa/stream.rs

@@ -1,3 +1,5 @@
+//! PipeWire device abstraction.
+
 use super::stream::StreamHandle;
 use crate::backends::pipewire::error::PipewireError;
 use crate::{
@@ -12,15 +14,21 @@ use std::cell::{Cell, RefCell};
 use std::collections::HashMap;
 use std::rc::Rc;
 
+/// A device (like a sound card) in PipeWire.
 pub struct PipewireDevice {
     pub(super) target_node: Option<u32>,
+    /// Additive flags describing the device (input/output/...)
     pub device_type: DeviceType,
+    /// Serial number of the device node in the PipeWire graph.
     pub object_serial: Option<String>,
+    /// Name to be used for the next created stream.
     pub stream_name: Cow<'static, str>,
+    /// Properties for the next created stream.
     pub stream_properties: HashMap<Vec<u8>, Vec<u8>>,
 }
 
 impl PipewireDevice {
+    /// Get PipeWire properties of the PipeWire device node.
     pub fn properties(&self) -> Result<Option<Properties>, PipewireError> {
         let Some(node_id) = self.target_node else {
             return Ok(None);

src/backends/pipewire/device.rs

@@ -1,3 +1,5 @@
+//! PipeWire driver abstraction.
+
 use super::error::PipewireError;
 use crate::backends::pipewire::device::PipewireDevice;
 use crate::backends::pipewire::utils;
@@ -6,6 +8,7 @@ use std::borrow::Cow;
 use std::collections::HashMap;
 use std::marker::PhantomData;
 
+/// The Interflow PipeWire backend driver.
 pub struct PipewireDriver {
     __init: PhantomData<()>,
 }

src/backends/pipewire/driver.rs

@@ -1,9 +1,14 @@
+//! PipeWire errors.
+
 use thiserror::Error;
 
+/// PipeWire error.
 #[derive(Debug, Error)]
 pub enum PipewireError {
+    /// Error originating in the PipeWire backend.
     #[error("Pipewire error: {0}")]
     BackendError(#[from] pipewire::Error),
+    /// Error creating a pipewire stream (SPA pod serialization problem).
     #[error("Cannot create Pipewire stream: {0}")]
     GenError(#[from] libspa::pod::serialize::GenError),
 }