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

//! Compact source-aware lineage carried on realtime audio frames.

use crate::frame::{ClockDomainId, SessionId, SourceId, StemId};

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct FrameLineage {
    pub(crate) session_id: SessionId,
    pub(crate) source_id: SourceId,
    pub(crate) stem_id: StemId,
    pub(crate) clock_id: ClockDomainId,
    pub(crate) sequence_num: u64,
    pub(crate) timestamp_start_ns: u64,
    pub(crate) duration_ns: u64,
    pub(crate) source_generation: u32,
    pub(crate) discontinuity_epoch: u64,
    pub(crate) permission_epoch: u64,
}

impl FrameLineage {
    #[allow(clippy::too_many_arguments)]
    pub fn try_new(
        session_id: SessionId,
        source_id: SourceId,
        stem_id: StemId,
        clock_id: ClockDomainId,
        sequence_num: u64,
        timestamp_start_ns: u64,
        duration_ns: u64,
        source_generation: u32,
        discontinuity_epoch: u64,
        permission_epoch: u64,
    ) -> Result<Self, FrameLineageBuildError> {
        if duration_ns == 0 {
            return Err(FrameLineageBuildError::ZeroDuration);
        }
        if source_generation == 0 {
            return Err(FrameLineageBuildError::ZeroSourceGeneration);
        }
        timestamp_start_ns
            .checked_add(duration_ns)
            .ok_or(FrameLineageBuildError::TimestampOverflow)?;
        Ok(Self {
            session_id,
            source_id,
            stem_id,
            clock_id,
            sequence_num,
            timestamp_start_ns,
            duration_ns,
            source_generation,
            discontinuity_epoch,
            permission_epoch,
        })
    }

    pub const fn session_id(self) -> SessionId {
        self.session_id
    }
    pub const fn source_id(self) -> SourceId {
        self.source_id
    }
    pub const fn stem_id(self) -> StemId {
        self.stem_id
    }
    pub const fn clock_id(self) -> ClockDomainId {
        self.clock_id
    }
    pub const fn sequence_number(self) -> u64 {
        self.sequence_num
    }
    pub const fn timestamp_start_ns(self) -> u64 {
        self.timestamp_start_ns
    }
    pub const fn duration_ns(self) -> u64 {
        self.duration_ns
    }
    pub const fn source_generation(self) -> u32 {
        self.source_generation
    }
    pub const fn discontinuity_epoch(self) -> u64 {
        self.discontinuity_epoch
    }
    pub const fn permission_epoch(self) -> u64 {
        self.permission_epoch
    }

    pub fn timestamp_end_ns(self) -> u64 {
        self.timestamp_start_ns.saturating_add(self.duration_ns)
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, thiserror::Error)]
pub enum FrameLineageBuildError {
    #[error("frame lineage duration must be non-zero")]
    ZeroDuration,
    #[error("frame lineage source generation must be non-zero")]
    ZeroSourceGeneration,
    #[error("frame lineage timestamp range overflows u64 nanoseconds")]
    TimestampOverflow,
}