1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
|
use std::{
sync::{
atomic::{AtomicU64, Ordering},
Arc,
},
thread::JoinHandle,
time::Instant,
};
use crate::{
host::fill_with_equilibrium, traits::StreamTrait, BackendSpecificError, InputCallbackInfo,
OutputCallbackInfo, SampleFormat, StreamConfig, StreamError, StreamInstant,
};
use pipewire::{
self as pw,
context::ContextRc,
main_loop::MainLoopRc,
spa::{
param::{
format::{MediaSubtype, MediaType},
format_utils,
},
pod::Pod,
},
stream::{StreamListener, StreamRc, StreamState},
};
use crate::Data;
#[derive(Debug, Clone, Copy)]
pub enum StreamCommand {
Toggle(bool),
Stop,
}
pub struct Stream {
pub(crate) handle: Option<JoinHandle<()>>,
pub(crate) controller: pw::channel::Sender<StreamCommand>,
pub(crate) last_quantum: Arc<AtomicU64>,
}
impl Drop for Stream {
fn drop(&mut self) {
let _ = self.controller.send(StreamCommand::Stop);
let _ = self.handle.take().map(|handle| handle.join());
}
}
impl StreamTrait for Stream {
fn play(&self) -> Result<(), crate::PlayStreamError> {
self.controller
.send(StreamCommand::Toggle(true))
.map_err(|_| crate::PlayStreamError::BackendSpecific {
err: BackendSpecificError {
description: "Cannot send message".to_owned(),
},
})?;
Ok(())
}
fn pause(&self) -> Result<(), crate::PauseStreamError> {
self.controller
.send(StreamCommand::Toggle(false))
.map_err(|_| crate::PauseStreamError::BackendSpecific {
err: BackendSpecificError {
description: "Cannot send message".to_owned(),
},
})?;
Ok(())
}
fn buffer_size(&self) -> Option<crate::FrameCount> {
match self.last_quantum.load(Ordering::Relaxed) {
0 => None,
n => Some(n as _),
}
}
}
pub(crate) const SUPPORTED_FORMATS: &[SampleFormat] = &[
SampleFormat::I8,
SampleFormat::U8,
SampleFormat::I16,
SampleFormat::U16,
SampleFormat::I24,
SampleFormat::U24,
SampleFormat::I32,
SampleFormat::U32,
SampleFormat::I64,
SampleFormat::U64,
SampleFormat::F32,
SampleFormat::F64,
];
impl From<SampleFormat> for pw::spa::param::audio::AudioFormat {
fn from(value: SampleFormat) -> Self {
match value {
SampleFormat::I8 => Self::S8,
SampleFormat::U8 => Self::U8,
#[cfg(target_endian = "little")]
SampleFormat::I16 => Self::S16LE,
#[cfg(target_endian = "big")]
SampleFormat::I16 => Self::S16BE,
#[cfg(target_endian = "little")]
SampleFormat::U16 => Self::U16LE,
#[cfg(target_endian = "big")]
SampleFormat::U16 => Self::U16BE,
#[cfg(target_endian = "little")]
SampleFormat::I24 => Self::S24LE,
#[cfg(target_endian = "big")]
SampleFormat::I24 => Self::S24BE,
#[cfg(target_endian = "little")]
SampleFormat::U24 => Self::U24LE,
#[cfg(target_endian = "big")]
SampleFormat::U24 => Self::U24BE,
#[cfg(target_endian = "little")]
SampleFormat::I32 => Self::S32LE,
#[cfg(target_endian = "big")]
SampleFormat::I32 => Self::S32BE,
#[cfg(target_endian = "little")]
SampleFormat::U32 => Self::U32LE,
#[cfg(target_endian = "big")]
SampleFormat::U32 => Self::U32BE,
#[cfg(target_endian = "little")]
SampleFormat::F32 => Self::F32LE,
#[cfg(target_endian = "big")]
SampleFormat::F32 => Self::F32BE,
#[cfg(target_endian = "little")]
SampleFormat::F64 => Self::F64LE,
#[cfg(target_endian = "big")]
SampleFormat::F64 => Self::F64BE,
// NOTE: Seems PipeWire does support U64 and I64, but libspa doesn't yet.
// TODO: Maybe add the support in the future
_ => Self::Unknown,
}
}
}
pub struct UserData<D, E> {
data_callback: D,
error_callback: E,
sample_format: SampleFormat,
format: pw::spa::param::audio::AudioInfoRaw,
created_instance: Instant,
last_quantum: Arc<AtomicU64>,
}
impl<D, E> UserData<D, E>
where
E: FnMut(StreamError) + Send + 'static,
{
fn state_changed(&mut self, new: StreamState) {
match new {
pipewire::stream::StreamState::Error(e) => {
(self.error_callback)(StreamError::BackendSpecific {
err: BackendSpecificError { description: e },
})
}
// TODO: maybe we need to log information when every new state comes?
pipewire::stream::StreamState::Paused => {}
pipewire::stream::StreamState::Streaming => {}
pipewire::stream::StreamState::Connecting => {}
pipewire::stream::StreamState::Unconnected => {}
}
}
}
/// Hardware timestamp from a PipeWire graph cycle.
struct PwTime {
/// CLOCK_MONOTONIC nanoseconds, stamped at the start of the graph cycle.
now_ns: i64,
/// Pipeline delay converted to nanoseconds.
/// For output: how far ahead of the driver our next sample will be played.
/// For input: how long ago the data in the buffer was captured.
delay_ns: i64,
}
/// Returns a hardware timestamp for the current graph cycle, or `None` if
/// the driver has not started yet or the rate is unavailable.
fn pw_stream_time(stream: &pw::stream::Stream) -> Option<PwTime> {
let mut t: pw::sys::pw_time = unsafe { std::mem::zeroed() };
let rc = unsafe {
pw::sys::pw_stream_get_time_n(
stream.as_raw_ptr(),
&mut t,
std::mem::size_of::<pw::sys::pw_time>(),
)
};
if rc != 0 || t.now == 0 || t.rate.denom == 0 {
return None;
}
debug_assert_eq!(t.rate.num, 1, "unexpected pw_time rate.num");
let delay_ns = t.delay * 1_000_000_000i64 / t.rate.denom as i64;
Some(PwTime {
now_ns: t.now,
delay_ns,
})
}
impl<D, E> UserData<D, E>
where
D: FnMut(&Data, &InputCallbackInfo) + Send + 'static,
E: FnMut(StreamError) + Send + 'static,
{
fn publish_data_in(
&mut self,
stream: &pw::stream::Stream,
frames: usize,
data: &Data,
) -> Result<(), BackendSpecificError> {
self.last_quantum.store(frames as u64, Ordering::Relaxed);
let (callback, capture) = match pw_stream_time(stream) {
Some(PwTime { now_ns, delay_ns }) => (
StreamInstant::from_nanos(now_ns),
StreamInstant::from_nanos(now_ns - delay_ns),
),
None => {
let cb = stream_timestamp_fallback(self.created_instance)?;
let pl = cb
.sub(frames_to_duration(frames, self.format.rate()))
.ok_or_else(|| BackendSpecificError {
description:
"`capture` occurs beyond representation supported by `StreamInstant`"
.to_string(),
})?;
(cb, pl)
}
};
let timestamp = crate::InputStreamTimestamp { callback, capture };
let info = InputCallbackInfo { timestamp };
(self.data_callback)(data, &info);
Ok(())
}
}
impl<D, E> UserData<D, E>
where
D: FnMut(&mut Data, &OutputCallbackInfo) + Send + 'static,
E: FnMut(StreamError) + Send + 'static,
{
fn publish_data_out(
&mut self,
stream: &pw::stream::Stream,
frames: usize,
data: &mut Data,
) -> Result<(), BackendSpecificError> {
self.last_quantum.store(frames as u64, Ordering::Relaxed);
let (callback, playback) = match pw_stream_time(stream) {
Some(PwTime { now_ns, delay_ns }) => (
StreamInstant::from_nanos(now_ns),
StreamInstant::from_nanos(now_ns + delay_ns),
),
None => {
let cb = stream_timestamp_fallback(self.created_instance)?;
let pl = cb
.add(frames_to_duration(frames, self.format.rate()))
.ok_or_else(|| BackendSpecificError {
description:
"`playback` occurs beyond representation supported by `StreamInstant`"
.to_string(),
})?;
(cb, pl)
}
};
let timestamp = crate::OutputStreamTimestamp { callback, playback };
let info = OutputCallbackInfo { timestamp };
(self.data_callback)(data, &info);
Ok(())
}
}
pub struct StreamData<D, E> {
pub mainloop: MainLoopRc,
pub listener: StreamListener<UserData<D, E>>,
pub stream: StreamRc,
pub context: ContextRc,
}
// Use elapsed duration since stream creation as fallback when hardware timestamps are unavailable.
//
// This ensures positive values that are compatible with our `StreamInstant` representation.
#[inline]
fn stream_timestamp_fallback(
creation: std::time::Instant,
) -> Result<StreamInstant, BackendSpecificError> {
let now = std::time::Instant::now();
let duration = now.duration_since(creation);
StreamInstant::from_nanos_i128(duration.as_nanos() as i128).ok_or(BackendSpecificError {
description: "stream duration has exceeded `StreamInstant` representation".to_string(),
})
}
// Convert the given duration in frames at the given sample rate to a `std::time::Duration`.
#[inline]
fn frames_to_duration(frames: usize, rate: crate::SampleRate) -> std::time::Duration {
let secsf = frames as f64 / rate as f64;
let secs = secsf as u64;
let nanos = ((secsf - secs as f64) * 1_000_000_000.0) as u32;
std::time::Duration::new(secs, nanos)
}
pub fn connect_output<D, E>(
config: StreamConfig,
properties: pw::properties::PropertiesBox,
sample_format: SampleFormat,
data_callback: D,
error_callback: E,
last_quantum: Arc<AtomicU64>,
) -> Result<StreamData<D, E>, pw::Error>
where
D: FnMut(&mut Data, &OutputCallbackInfo) + Send + 'static,
E: FnMut(StreamError) + Send + 'static,
{
pw::init();
let mainloop = pw::main_loop::MainLoopRc::new(None)?;
let context = pw::context::ContextRc::new(&mainloop, None)?;
let core = context.connect_rc(None)?;
let data = UserData {
data_callback,
error_callback,
sample_format,
format: Default::default(),
created_instance: Instant::now(),
last_quantum,
};
let channels = config.channels as _;
let rate = config.sample_rate as _;
let stream = pw::stream::StreamRc::new(core, "cpal-playback", properties)?;
let listener = stream
.add_local_listener_with_user_data(data)
.param_changed(move|stream, user_data, id, param| {
let Some(param) = param else {
return;
};
if id != pw::spa::param::ParamType::Format.as_raw() {
return;
}
let (media_type, media_subtype) = match format_utils::parse_format(param) {
Ok(v) => v,
Err(_) => return,
};
// only accept raw audio
if media_type != MediaType::Audio || media_subtype != MediaSubtype::Raw {
return;
}
// call a helper function to parse the format for us.
// When the format update, we check the format first, in case it does not fit what we
// set
if user_data.format.parse(param).is_ok() {
let current_channels = user_data.format.channels();
let current_rate = user_data.format.rate();
if current_channels != channels || rate != current_rate {
(user_data.error_callback)(StreamError::BackendSpecific {
err: BackendSpecificError {
description: format!("channels or rate is not fit, current channels: {current_channels}, current rate: {current_rate}"),
},
});
// if the channels and rate do not match, we stop the stream
if let Err(e) = stream.set_active(false) {
(user_data.error_callback)(StreamError::BackendSpecific {
err: BackendSpecificError {
description: format!("failed to stop the stream, reason: {e}"),
},
});
}
}
}
})
.state_changed(|_stream, user_data, _old, new| {
user_data.state_changed(new);
})
.process(|stream, user_data| match stream.dequeue_buffer() {
None => (user_data.error_callback)(StreamError::BufferUnderrun),
Some(mut buffer) => {
// Read the requested frame count before mutably borrowing datas_mut().
let requested = buffer.requested() as usize;
let datas = buffer.datas_mut();
if datas.is_empty() {
return;
}
let buf_data = &mut datas[0];
let n_channels = user_data.format.channels();
let stride = user_data.sample_format.sample_size() * n_channels as usize;
// frames = samples / channels or frames = data_len / stride
// Honor the frame count PipeWire requests this cycle, capped by the
// mapped buffer capacity to guard against any mismatch.
let frames = requested.min(buf_data.as_raw().maxsize as usize / stride);
let Some(samples) = buf_data.data() else {
return;
};
// samples = frames * channels or samples = data_len / sample_size
let n_samples = frames * n_channels as usize;
// Pre-fill only the active region with silence before handing it to the callback.
let active = &mut samples[..frames * stride];
fill_with_equilibrium(active, user_data.sample_format);
let data = active.as_mut_ptr() as *mut ();
let mut data =
unsafe { Data::from_parts(data, n_samples, user_data.sample_format) };
if let Err(err) = user_data.publish_data_out(stream, frames, &mut data) {
(user_data.error_callback)(StreamError::BackendSpecific { err });
}
let chunk = buf_data.chunk_mut();
*chunk.offset_mut() = 0;
*chunk.stride_mut() = stride as i32;
*chunk.size_mut() = (frames * stride) as u32;
}
})
.register()?;
let mut audio_info = pw::spa::param::audio::AudioInfoRaw::new();
audio_info.set_format(sample_format.into());
audio_info.set_rate(rate);
audio_info.set_channels(channels);
let obj = pw::spa::pod::Object {
type_: pw::spa::utils::SpaTypes::ObjectParamFormat.as_raw(),
id: pw::spa::param::ParamType::EnumFormat.as_raw(),
properties: audio_info.into(),
};
let values: Vec<u8> = pw::spa::pod::serialize::PodSerializer::serialize(
std::io::Cursor::new(Vec::new()),
&pw::spa::pod::Value::Object(obj),
)
.unwrap()
.0
.into_inner();
let mut params = [Pod::from_bytes(&values).unwrap()];
// TODO: what about RT_PROCESS?
/* Now connect this stream. We ask that our process function is
* called in a realtime thread. */
stream.connect(
pw::spa::utils::Direction::Output,
None,
pw::stream::StreamFlags::AUTOCONNECT | pw::stream::StreamFlags::MAP_BUFFERS,
&mut params,
)?;
Ok(StreamData {
mainloop,
listener,
stream,
context,
})
}
pub fn connect_input<D, E>(
config: StreamConfig,
properties: pw::properties::PropertiesBox,
sample_format: SampleFormat,
data_callback: D,
error_callback: E,
last_quantum: Arc<AtomicU64>,
) -> Result<StreamData<D, E>, pw::Error>
where
D: FnMut(&Data, &InputCallbackInfo) + Send + 'static,
E: FnMut(StreamError) + Send + 'static,
{
pw::init();
let mainloop = pw::main_loop::MainLoopRc::new(None)?;
let context = pw::context::ContextRc::new(&mainloop, None)?;
let core = context.connect_rc(None)?;
let data = UserData {
data_callback,
error_callback,
sample_format,
format: Default::default(),
created_instance: Instant::now(),
last_quantum,
};
let channels = config.channels as _;
let rate = config.sample_rate as _;
let stream = pw::stream::StreamRc::new(core, "cpal-capture", properties)?;
let listener = stream
.add_local_listener_with_user_data(data)
.param_changed(move |stream, user_data, id, param| {
let Some(param) = param else {
return;
};
if id != pw::spa::param::ParamType::Format.as_raw() {
return;
}
let (media_type, media_subtype) = match format_utils::parse_format(param) {
Ok(v) => v,
Err(_) => return,
};
// only accept raw audio
if media_type != MediaType::Audio || media_subtype != MediaSubtype::Raw {
return;
}
// call a helper function to parse the format for us.
// When the format update, we check the format first, in case it does not fit what we
// set
if user_data.format.parse(param).is_ok() {
let current_channels = user_data.format.channels();
let current_rate = user_data.format.rate();
if current_channels != channels || rate != current_rate {
(user_data.error_callback)(StreamError::BackendSpecific {
err: BackendSpecificError {
description: format!("channels or rate is not fit, current channels: {current_channels}, current rate: {current_rate}"),
},
});
// if the channels and rate do not match, we stop the stream
if let Err(e) = stream.set_active(false) {
(user_data.error_callback)(StreamError::BackendSpecific {
err: BackendSpecificError {
description: format!("failed to stop the stream, reason: {e}"),
},
});
}
}
}
})
.state_changed(|_stream, user_data, _old, new| {
user_data.state_changed(new);
})
.process(|stream, user_data| match stream.dequeue_buffer() {
None => (user_data.error_callback)(StreamError::BufferUnderrun),
Some(mut buffer) => {
let datas = buffer.datas_mut();
if datas.is_empty() {
return;
}
let data = &mut datas[0];
let n_channels = user_data.format.channels();
let n_samples = data.chunk().size() / user_data.sample_format.sample_size() as u32;
let frames = n_samples / n_channels;
let Some(samples) = data.data() else {
return;
};
let data = samples.as_mut_ptr() as *mut ();
let data =
unsafe { Data::from_parts(data, n_samples as usize, user_data.sample_format) };
if let Err(err) = user_data.publish_data_in(stream, frames as usize, &data) {
(user_data.error_callback)(StreamError::BackendSpecific { err });
}
}
})
.register()?;
let mut audio_info = pw::spa::param::audio::AudioInfoRaw::new();
audio_info.set_format(sample_format.into());
audio_info.set_rate(rate);
audio_info.set_channels(channels);
let obj = pw::spa::pod::Object {
type_: pw::spa::utils::SpaTypes::ObjectParamFormat.as_raw(),
id: pw::spa::param::ParamType::EnumFormat.as_raw(),
properties: audio_info.into(),
};
let values: Vec<u8> = pw::spa::pod::serialize::PodSerializer::serialize(
std::io::Cursor::new(Vec::new()),
&pw::spa::pod::Value::Object(obj),
)
.unwrap()
.0
.into_inner();
let mut params = [Pod::from_bytes(&values).unwrap()];
// TODO: what about RT_PROCESS?
/* Now connect this stream. We ask that our process function is
* called in a realtime thread. */
stream.connect(
pw::spa::utils::Direction::Input,
None,
pw::stream::StreamFlags::AUTOCONNECT | pw::stream::StreamFlags::MAP_BUFFERS,
&mut params,
)?;
Ok(StreamData {
mainloop,
listener,
stream,
context,
})
}
|