rill-io 0.5.0-beta.1

Audio I/O backends for Rill - CPAL, ALSA, PipeWire, JACK
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

//! Shared ring buffer handles for PipeWire I/O.
//!
//! PipeWire uses a push model — its RT callbacks read/write ring buffers.
//! The audio thread reads/writes the same rings during `process_block()`:
//!
//! ```text
//! PW input callback ──write──→ input_ring ──read──→ AudioInput::generate()
//! AudioOutput::consume() ──write──→ output_ring ──read──→ PW output callback
//! ```
//!
//! [`PwBuffers`] holds both rings.

use std::sync::Arc;

use crate::buffer::IoRingBuffer;

/// Input and output ring buffers shared between PipeWire and graph nodes.
/// Input and output ring buffers shared between PipeWire and graph nodes.
pub struct PwBuffers {
    /// Ring buffer written by the PipeWire input callback and read by `AudioInput::generate()`.
    pub input: Arc<IoRingBuffer>,
    /// Ring buffer written by `AudioOutput::consume()` and read by the PipeWire output callback.
    pub output: Arc<IoRingBuffer>,
}