pocketstation 1.0.1

Source-aware desktop audio Session SDK
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
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
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
use std::sync::Arc;

use super::pool::{AudioBufferHandle, AudioBufferPool, SharedAudioBufferHandle};
use crate::frame::{FrameLineage, SourceId, StreamId};

pub const SAMPLE_RATE_HZ: u32 = 48_000;
#[cfg(test)]
const FRAME_DURATION_MS: u32 = 20;
#[cfg(any(test, feature = "internal-testing", target_os = "linux"))]
pub const POOL_SLOT_SAMPLES: usize = 960; // 20ms × 48kHz

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum SampleFormat {
    F32Interleaved,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct SampleSpec {
    pub sample_rate_hz: u32,
    pub channels: u8,
    pub format: SampleFormat,
}

impl SampleSpec {
    pub fn new(sample_rate_hz: u32, channels: u8, format: SampleFormat) -> Self {
        Self {
            sample_rate_hz,
            channels,
            format,
        }
    }

    pub fn frame_samples_for_duration_ms(&self, duration_ms: u32) -> usize {
        (self.sample_rate_hz * duration_ms / 1000) as usize * self.channels as usize
    }
}

#[derive(Debug)]
pub struct AudioFrame {
    pub(crate) stream_id: StreamId,
    pub(crate) source_id: SourceId,
    pub(crate) sample_rate_hz: u32,
    pub(crate) channels: u8,
    pub(crate) format: SampleFormat,
    pub(crate) timestamp_ns: u64,
    pub(crate) sequence_number: u64,
    pub(crate) buffer: AudioBufferHandle,
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, thiserror::Error)]
pub enum AudioFrameBuildError {
    #[error("audio frame sample rate must be non-zero")]
    ZeroSampleRate,
    #[error("audio frame channel count must be non-zero")]
    ZeroChannels,
    #[error("audio frame sample count {samples} is not divisible by {channels} channels")]
    MisalignedSamples { samples: usize, channels: u8 },
}

impl AudioFrame {
    pub fn try_new(
        stream_id: StreamId,
        source_id: SourceId,
        sequence_number: u64,
        timestamp_ns: u64,
        sample_spec: SampleSpec,
        buffer: AudioBufferHandle,
    ) -> Result<Self, AudioFrameBuildError> {
        if sample_spec.sample_rate_hz == 0 {
            return Err(AudioFrameBuildError::ZeroSampleRate);
        }
        if sample_spec.channels == 0 {
            return Err(AudioFrameBuildError::ZeroChannels);
        }
        if !buffer
            .len()
            .is_multiple_of(usize::from(sample_spec.channels))
        {
            return Err(AudioFrameBuildError::MisalignedSamples {
                samples: buffer.len(),
                channels: sample_spec.channels,
            });
        }
        Ok(Self {
            stream_id,
            source_id,
            sample_rate_hz: sample_spec.sample_rate_hz,
            channels: sample_spec.channels,
            format: sample_spec.format,
            timestamp_ns,
            sequence_number,
            buffer,
        })
    }

    /// Constructs a frame after the owning backend validated its negotiated
    /// sample specification and buffer shape during setup.
    pub(crate) fn new(
        stream_id: StreamId,
        source_id: SourceId,
        sequence_number: u64,
        timestamp_ns: u64,
        channels: u8,
        buffer: AudioBufferHandle,
    ) -> Self {
        Self {
            stream_id,
            source_id,
            sample_rate_hz: SAMPLE_RATE_HZ,
            channels,
            format: SampleFormat::F32Interleaved,
            timestamp_ns,
            sequence_number,
            buffer,
        }
    }

    pub const fn stream_id(&self) -> StreamId {
        self.stream_id
    }

    pub const fn source_id(&self) -> SourceId {
        self.source_id
    }

    pub const fn sample_rate_hz(&self) -> u32 {
        self.sample_rate_hz
    }

    pub const fn channels(&self) -> u8 {
        self.channels
    }

    pub const fn format(&self) -> SampleFormat {
        self.format
    }

    pub const fn timestamp_ns(&self) -> u64 {
        self.timestamp_ns
    }

    pub const fn sequence_number(&self) -> u64 {
        self.sequence_number
    }

    pub fn samples(&self) -> &[f32] {
        self.buffer.as_slice()
    }

    pub fn freeze(self) -> Option<SharedAudioFrame> {
        let Self {
            stream_id,
            source_id,
            sample_rate_hz,
            channels,
            format,
            timestamp_ns,
            sequence_number,
            buffer,
        } = self;
        let buffer = buffer.freeze().ok()?;
        Some(SharedAudioFrame {
            stream_id,
            source_id,
            sample_rate_hz,
            channels,
            format,
            timestamp_ns,
            sequence_number,
            buffer,
        })
    }
}

#[derive(Debug)]
pub struct SharedAudioFrame {
    pub(crate) stream_id: StreamId,
    pub(crate) source_id: SourceId,
    pub(crate) sample_rate_hz: u32,
    pub(crate) channels: u8,
    pub(crate) format: SampleFormat,
    pub(crate) timestamp_ns: u64,
    pub(crate) sequence_number: u64,
    pub(crate) buffer: SharedAudioBufferHandle,
}

impl SharedAudioFrame {
    pub const fn stream_id(&self) -> StreamId {
        self.stream_id
    }

    pub const fn source_id(&self) -> SourceId {
        self.source_id
    }

    pub const fn sample_rate_hz(&self) -> u32 {
        self.sample_rate_hz
    }

    pub const fn channels(&self) -> u8 {
        self.channels
    }

    pub const fn format(&self) -> SampleFormat {
        self.format
    }

    pub const fn timestamp_ns(&self) -> u64 {
        self.timestamp_ns
    }

    pub const fn sequence_number(&self) -> u64 {
        self.sequence_number
    }

    pub fn samples(&self) -> &[f32] {
        self.buffer.as_slice()
    }

    pub fn try_clone(&self) -> Option<Self> {
        Some(Self {
            stream_id: self.stream_id,
            source_id: self.source_id,
            sample_rate_hz: self.sample_rate_hz,
            channels: self.channels,
            format: self.format,
            timestamp_ns: self.timestamp_ns,
            sequence_number: self.sequence_number,
            buffer: self.buffer.try_clone()?,
        })
    }

    pub fn copy_to_pool(&self, pool: &Arc<AudioBufferPool>) -> Option<AudioFrame> {
        let mut buffer = pool.acquire()?;
        buffer.try_copy_from_slice(self.buffer.as_slice()).ok()?;
        Some(AudioFrame {
            stream_id: self.stream_id,
            source_id: self.source_id,
            sample_rate_hz: self.sample_rate_hz,
            channels: self.channels,
            format: self.format,
            timestamp_ns: self.timestamp_ns,
            sequence_number: self.sequence_number,
            buffer,
        })
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, thiserror::Error)]
pub enum FrameLineageError {
    #[error("frame source id does not match its lineage")]
    Source,
    #[error("frame sequence number does not match its lineage")]
    SequenceNumber,
    #[error("frame timestamp does not match its lineage")]
    Timestamp,
}

/// An exclusive audio frame and the immutable lineage snapshot captured before
/// the frame crosses a bounded edge.
///
/// This envelope keeps dynamic source-generation, discontinuity, and
/// permission epochs attached to the samples they describe. Construction is
/// allocation-free and validates the fields duplicated by `AudioFrame`.
#[derive(Debug)]
pub struct LineagedAudioFrame {
    frame: AudioFrame,
    lineage: FrameLineage,
}

impl LineagedAudioFrame {
    pub fn new(frame: AudioFrame, lineage: FrameLineage) -> Result<Self, FrameLineageError> {
        validate_frame_lineage(&frame, lineage)?;
        Ok(Self { frame, lineage })
    }

    pub const fn frame(&self) -> &AudioFrame {
        &self.frame
    }

    pub const fn lineage(&self) -> FrameLineage {
        self.lineage
    }

    pub fn into_parts(self) -> (AudioFrame, FrameLineage) {
        (self.frame, self.lineage)
    }

    pub fn freeze(self) -> Option<SharedLineagedAudioFrame> {
        Some(SharedLineagedAudioFrame {
            frame: self.frame.freeze()?,
            lineage: self.lineage,
        })
    }
}

#[derive(Debug)]
pub struct SharedLineagedAudioFrame {
    frame: SharedAudioFrame,
    lineage: FrameLineage,
}

impl SharedLineagedAudioFrame {
    pub const fn frame(&self) -> &SharedAudioFrame {
        &self.frame
    }

    pub const fn lineage(&self) -> FrameLineage {
        self.lineage
    }

    pub fn try_clone(&self) -> Option<Self> {
        Some(Self {
            frame: self.frame.try_clone()?,
            lineage: self.lineage,
        })
    }

    pub fn copy_to_pool(&self, pool: &Arc<AudioBufferPool>) -> Option<LineagedAudioFrame> {
        Some(LineagedAudioFrame {
            frame: self.frame.copy_to_pool(pool)?,
            lineage: self.lineage,
        })
    }
}

fn validate_frame_lineage(
    frame: &AudioFrame,
    lineage: FrameLineage,
) -> Result<(), FrameLineageError> {
    if frame.source_id != lineage.source_id {
        return Err(FrameLineageError::Source);
    }
    if frame.sequence_number != lineage.sequence_num {
        return Err(FrameLineageError::SequenceNumber);
    }
    if frame.timestamp_ns != lineage.timestamp_start_ns {
        return Err(FrameLineageError::Timestamp);
    }
    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::frame::{ClockDomainId, SessionId, StemId};

    #[test]
    fn given_pool_with_4_slots_when_all_acquired_then_next_acquire_returns_none() {
        // Given
        let pool = AudioBufferPool::new(4, 16);

        // When
        let a = pool.acquire().unwrap();
        let b = pool.acquire().unwrap();
        let c = pool.acquire().unwrap();
        let d = pool.acquire().unwrap();

        // Then
        assert!(pool.acquire().is_none());
        drop(a);
        drop(b);
        drop(c);
        drop(d);
        assert!(pool.acquire().is_some());
    }

    #[test]
    fn given_pool_acquisition_and_release_when_observed_then_available_slots_are_exact() {
        let pool = AudioBufferPool::new(2, 4);
        assert_eq!(pool.available_slots(), 2);

        let handle = pool.acquire().unwrap();
        assert_eq!(pool.available_slots(), 1);

        drop(handle);
        assert_eq!(pool.available_slots(), 2);
    }

    #[test]
    fn given_acquired_handle_when_copy_from_slice_then_length_matches_data() {
        // Given
        let pool = AudioBufferPool::new(1, 8);
        let mut h = pool.acquire().unwrap();

        // When
        h.try_copy_from_slice(&[1.0, 2.0, 3.0]).unwrap();

        // Then
        assert_eq!(h.len(), 3);
        assert_eq!(h.as_slice(), &[1.0, 2.0, 3.0]);
    }

    #[test]
    fn given_full_64_slot_pool_when_acquire_then_returns_none_and_increments_failures() {
        // Given
        let pool = AudioBufferPool::new(64, 4);

        // When
        let handles: Vec<_> = (0..64).map(|_| pool.acquire().unwrap()).collect();
        let extra = pool.acquire();

        // Then
        assert_eq!(pool.acquire_failures(), 1);
        assert!(extra.is_none());
        drop(handles);
    }

    #[test]
    fn given_exhausted_pool_when_handle_dropped_then_reacquire_succeeds() {
        // Given
        let pool = AudioBufferPool::new(1, 4);
        let h = pool.acquire().unwrap();
        assert!(pool.acquire().is_none());

        // When
        drop(h);

        // Then
        assert!(pool.acquire().is_some());
    }

    #[test]
    fn given_pool_when_acquire_and_release_then_in_use_flag_tracks_state() {
        // Given
        let pool = AudioBufferPool::new(2, 4);
        let h = pool.acquire().unwrap();
        let slot = h.index();

        // When / Then
        assert!(pool.is_in_use(slot));
        drop(h);
        assert!(!pool.is_in_use(slot));
    }

    #[test]
    fn given_48khz_mono_spec_when_frame_samples_for_20ms_then_returns_960() {
        // Given
        let spec = SampleSpec::new(SAMPLE_RATE_HZ, 1, SampleFormat::F32Interleaved);

        // When
        let samples = spec.frame_samples_for_duration_ms(FRAME_DURATION_MS);

        // Then
        assert_eq!(samples, 960);
    }

    #[test]
    fn given_48khz_stereo_spec_when_frame_samples_for_20ms_then_returns_1920() {
        // Given
        let spec = SampleSpec::new(SAMPLE_RATE_HZ, 2, SampleFormat::F32Interleaved);

        // When
        let samples = spec.frame_samples_for_duration_ms(FRAME_DURATION_MS);

        // Then
        assert_eq!(samples, 1920);
    }

    #[test]
    fn given_frame_lineage_when_timestamp_end_requested_then_duration_is_saturating() {
        // Given
        let lineage = FrameLineage {
            session_id: SessionId(1),
            source_id: SourceId(2),
            stem_id: StemId(3),
            clock_id: ClockDomainId(4),
            sequence_num: 5,
            timestamp_start_ns: u64::MAX - 2,
            duration_ns: 10,
            source_generation: 6,
            discontinuity_epoch: 7,
            permission_epoch: 8,
        };

        // When / Then
        assert_eq!(lineage.timestamp_end_ns(), u64::MAX);
    }

    #[test]
    fn given_matching_frame_and_lineage_when_frozen_then_epochs_survive_fanout() {
        // Given
        let pool = AudioBufferPool::new(2, 4);
        let mut buffer = pool.acquire().unwrap();
        buffer.try_copy_from_slice(&[0.1, 0.2, 0.3, 0.4]).unwrap();
        let frame = AudioFrame::new(StreamId(1), SourceId(2), 3, 4, 1, buffer);
        let lineage = FrameLineage {
            session_id: SessionId(5),
            source_id: SourceId(2),
            stem_id: StemId(6),
            clock_id: ClockDomainId(7),
            sequence_num: 3,
            timestamp_start_ns: 4,
            duration_ns: 80_000,
            source_generation: 8,
            discontinuity_epoch: 9,
            permission_epoch: 10,
        };

        // When
        let exclusive = LineagedAudioFrame::new(frame, lineage).unwrap();
        let shared = exclusive.freeze().unwrap();
        let second_delivery = shared.try_clone().unwrap();
        let copied = second_delivery.copy_to_pool(&pool).unwrap();

        // Then
        assert_eq!(shared.lineage(), lineage);
        assert_eq!(copied.lineage(), lineage);
        assert_eq!(copied.frame().buffer.as_slice(), &[0.1, 0.2, 0.3, 0.4]);
    }

    #[test]
    fn given_mismatched_dynamic_frame_identity_when_enveloped_then_rejected() {
        // Given
        let pool = AudioBufferPool::new(1, 4);
        let buffer = pool.acquire().unwrap();
        let frame = AudioFrame::new(StreamId(1), SourceId(2), 3, 4, 1, buffer);
        let lineage = FrameLineage {
            session_id: SessionId(5),
            source_id: SourceId(99),
            stem_id: StemId(6),
            clock_id: ClockDomainId(7),
            sequence_num: 3,
            timestamp_start_ns: 4,
            duration_ns: 80_000,
            source_generation: 8,
            discontinuity_epoch: 9,
            permission_epoch: 10,
        };

        // When
        let result = LineagedAudioFrame::new(frame, lineage);

        // Then
        assert!(matches!(result, Err(FrameLineageError::Source)));
    }

    #[test]
    fn given_frozen_buffer_with_many_consumers_when_final_handle_drops_then_slot_is_reused() {
        // Given
        let pool = AudioBufferPool::new(1, 4);
        let mut exclusive = pool.acquire().unwrap();
        exclusive
            .try_copy_from_slice(&[0.1, 0.2, 0.3, 0.4])
            .unwrap();
        let shared = exclusive.freeze().unwrap();
        let second = shared.try_clone().unwrap();
        let third = shared.try_clone().unwrap();

        // When / Then
        assert_eq!(shared.shared_ref_count(), 3);
        assert!(pool.acquire().is_none());
        drop(second);
        drop(shared);
        assert!(pool.acquire().is_none());
        drop(third);
        assert!(pool.acquire().is_some());
    }

    #[test]
    fn given_rejected_shared_branch_when_handle_drops_then_reference_is_released() {
        // Given
        let pool = AudioBufferPool::new(1, 2);
        let shared = pool.acquire().unwrap().freeze().unwrap();
        let rejected_branch = shared.try_clone().unwrap();

        // When
        drop(rejected_branch);

        // Then
        assert_eq!(shared.shared_ref_count(), 1);
    }

    #[test]
    fn given_queued_shared_branches_when_queue_drops_then_all_references_are_released() {
        // Given
        let pool = AudioBufferPool::new(1, 2);
        let shared = pool.acquire().unwrap().freeze().unwrap();
        let queued = vec![shared.try_clone().unwrap(), shared.try_clone().unwrap()];
        assert_eq!(shared.shared_ref_count(), 3);

        // When
        drop(queued);

        // Then
        assert_eq!(shared.shared_ref_count(), 1);
    }

    #[test]
    fn given_shared_frame_when_copied_to_branch_pool_then_samples_are_independent() {
        // Given
        let source_pool = AudioBufferPool::new(1, 3);
        let branch_pool = AudioBufferPool::new(1, 3);
        let mut buffer = source_pool.acquire().unwrap();
        buffer.try_copy_from_slice(&[0.25, -0.5, 0.75]).unwrap();
        let shared = AudioFrame::new(StreamId(11), SourceId(2), 5, 6, 1, buffer)
            .freeze()
            .unwrap();

        // When
        let mut branch = shared.copy_to_pool(&branch_pool).unwrap();
        branch.buffer.as_mut_slice()[0] = 1.0;

        // Then
        assert_eq!(shared.buffer.as_slice(), &[0.25, -0.5, 0.75]);
        assert_eq!(branch.buffer.as_slice(), &[1.0, -0.5, 0.75]);
        assert_eq!(branch.source_id, shared.source_id);
        assert_eq!(branch.sequence_number, shared.sequence_number);
        assert_eq!(branch.timestamp_ns, shared.timestamp_ns);
        assert!(shared.copy_to_pool(&branch_pool).is_none());
    }

    #[test]
    fn given_shared_reference_at_max_when_clone_attempted_then_clone_fails_without_wraparound() {
        // Given
        let pool = AudioBufferPool::new(1, 1);
        let shared = pool.acquire().unwrap().freeze().unwrap();
        pool.set_shared_ref_count_for_testing(0, usize::MAX);

        // When / Then
        assert!(shared.try_clone().is_none());
        assert_eq!(pool.shared_ref_count(0), usize::MAX);
    }

    #[test]
    fn given_zero_shared_references_when_release_attempted_then_underflow_is_rejected() {
        // Given
        let pool = AudioBufferPool::new(1, 1);

        // When / Then
        assert!(!pool.release_shared_for_testing(0));
        assert_eq!(pool.shared_ref_count(0), 0);
        assert!(pool.acquire().is_some());
    }
}