openairplay2 0.3.0

Embeddable AirPlay 2 audio receiver library (network in, PCM + events out)
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

//! An embeddable AirPlay 2 audio **receiver**: a real Mac/iPhone discovers
//! it, pairs with it, and streams to it; the host application gets decoded
//! PCM and session events. The library owns network → PCM (discovery
//! advertisement, transient pairing, the encrypted control channel, the
//! buffered-audio channel, decrypt, AAC decode, and the pause/seek/
//! backpressure semantics); the host owns PCM → speaker via an [`AudioSink`].
//!
//! Deliberate scope: one sender → one stream → one output. No PTP — for a
//! single output, the sender's buffering plus this library's backpressure
//! suffice (blocking [`AudioSink::write`] paces playback). No AirPlay wire
//! concepts (plists, `shk`, sequence numbers) appear in this API.
//!
//! ```no_run
//! use openairplay2::{AudioSink, Event, Receiver};
//!
//! struct MySink;
//!
//! impl AudioSink for MySink {
//!     fn write(&mut self, pcm: &[i16]) { /* blocking write paces playback */ }
//!     fn flush(&mut self) { /* seek: drop device/prebuffer state */ }
//! }
//!
//! #[tokio::main]
//! async fn main() -> std::io::Result<()> {
//!     let receiver = Receiver::builder()
//!         .name("Office")
//!         .identity_path("/var/lib/myapp/airplay-identity")
//!         .build()?;
//!     let (events, mut rx) = tokio::sync::mpsc::unbounded_channel();
//!     tokio::spawn(async move {
//!         while let Some(event) = rx.recv().await {
//!             if let Event::Volume { db } = event { /* your gain path */ }
//!         }
//!     });
//!     receiver.run(|_rate, _channels| Box::new(MySink), events).await
//! }
//! ```

#![warn(missing_docs)]

mod avahi;
mod buffered;
mod crypto_stream;
mod decode;
mod dmap;
mod events;
mod fairplay;
mod http;
mod identity;
mod info;
mod mac;
mod pairing;
mod player;
mod receiver;
mod session;
mod sink;

// Sender-side pieces the integration tests (and a future test-sender) drive
// the real server with. Public so the tests can reach them, but not part of
// the documented embedding API.
#[doc(hidden)]
pub mod cipher;
#[doc(hidden)]
pub mod server;
#[doc(hidden)]
pub mod srp;
#[doc(hidden)]
pub mod tlv;

pub use events::{Event, EventSender};
pub use identity::Identity;
pub use info::txt_records;
pub use receiver::{Receiver, ReceiverBuilder};
pub use sink::{AudioSink, SinkFactory};

/// Receiver-wide configuration, resolved by [`ReceiverBuilder::build`].
#[derive(Debug, Clone)]
pub struct Config {
    /// The receiver name senders see in the AirPlay picker.
    pub name: String,
    /// TCP port of the HTTP/RTSP control server.
    pub port: u16,
    /// The MAC address used as the AirPlay `deviceid`.
    pub mac: [u8; 6],
    /// Apple model string, e.g. `OpenAirPlay2,1`.
    pub model: String,
    /// AirPlay source version, e.g. `366.0`.
    pub source_version: String,
    /// 64-bit AirPlay 2 capability bitmask.
    pub features: u64,
    /// AirPlay status flags.
    pub status_flags: u32,
    /// `Some` → require this pincode to pair (advertised as "password
    /// required" via status-flag bit 7; a sender enters it in transient
    /// pairing). `None` → the standard transient code `3939`. Unlike
    /// openairplay1 there is no "open" mode — AirPlay 2 always pairs. Never
    /// logged.
    pub pincode: Option<String>,
}

impl Config {
    /// MAC as colon-separated uppercase hex, e.g. `AA:BB:CC:DD:EE:FF`. This is
    /// the AirPlay `deviceid`.
    pub fn device_id(&self) -> String {
        self.mac
            .iter()
            .map(|b| format!("{b:02X}"))
            .collect::<Vec<_>>()
            .join(":")
    }

    /// The `features` bitmask split into `(low32, high32)`, the form used in
    /// both the mDNS TXT record and `GET /info`.
    pub fn features_split(&self) -> (u32, u32) {
        (self.features as u32, (self.features >> 32) as u32)
    }
}