arcly-stream 0.8.3

An open-extensible live-media streaming kernel: lock-free zero-copy frame fan-out, instant-start GOP cache, a pluggable multi-protocol ingestion layer (RTMP, RTSP, SRT, WHIP/WHEP shipped), and a feature-gated pure-Rust media plane (MPEG-TS/HLS/fMP4) — runtime, config, and metrics free.
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
//! One SRT connection (per peer address), driven by the server's demux loop.
//!
//! A connection answers the induction/conclusion handshake, learns its
//! `streamid` (which selects the `app/stream` and the mode), then runs one of
//! two roles to completion:
//!
//! * **publish** (`m=publish`, the default) — reorder data through the ARQ
//!   window, demux MPEG-TS, and publish access units onto the bus.
//! * **request** (`m=request`) — subscribe to the stream, mux it back to
//!   MPEG-TS, and send it as SRT data packets with ARQ retransmission.
//!
//! All per-connection state (ARQ buffers, encryption key material, the publish
//! session or playback subscription) lives in the task this module spawns, so
//! many connections run independently on the single shared `UdpSocket`.

use std::net::SocketAddr;
use std::sync::Arc;
use std::time::Instant;

use tokio::net::UdpSocket;
use tokio::sync::mpsc;
use tokio_util::sync::CancellationToken;
use tracing::{debug, info, warn};

use super::arq::{self, Receiver, SendBuffer};
use super::packet::{build_data_packet, ControlType, SrtPacket};
use super::{handshake, resolve_streamid, ARQ_WINDOW, CONTROL_INTERVAL};
use crate::bus::PlaybackRegistry;
use crate::inbound::{IngestContext, PublishSession};
use crate::packager::{MpegTsMuxer, Muxer};
use crate::protocol::tsdemux::{TsDemuxer, TsTrackKind};
use crate::{CodecId, MediaFrame, StreamKey};

#[cfg(feature = "srt-encrypt")]
use super::keymaterial::KeyMaterial;

/// One full SRT datagram of TS payload (7 × 188-byte TS packets).
const TS_BYTES_PER_DATAGRAM: usize = 7 * 188;
/// Outbound (egress) retransmission window.
const SEND_WINDOW: usize = 4096;
/// Give up a half-open connection that goes idle during/after the handshake.
const IDLE_TIMEOUT: std::time::Duration = std::time::Duration::from_secs(30);

/// Everything a connection task needs, handed over by the demux loop.
pub(super) struct ConnConfig {
    pub socket: Arc<UdpSocket>,
    pub peer: SocketAddr,
    pub ctx: IngestContext,
    pub playback: Option<Arc<dyn PlaybackRegistry>>,
    pub gate: Option<crate::auth::EgressGate>,
    pub default_key: StreamKey,
    #[cfg(feature = "srt-encrypt")]
    pub passphrase: Option<String>,
    pub shutdown: CancellationToken,
}

/// True if `dg` is an SRT control **handshake** — the only packet that opens a
/// connection.
pub(super) fn is_handshake(dg: &[u8]) -> bool {
    matches!(
        SrtPacket::parse(dg),
        Some(SrtPacket::Control {
            control_type: ControlType::Handshake,
            ..
        })
    )
}

#[derive(Clone, Copy, PartialEq)]
enum Mode {
    Publish,
    Request,
}

/// Parse the `streamid` resource fields: `m=` selects the mode, `t=`/`u=`
/// carries an optional publish/play token. The resource (`r=` / bare) is handled
/// separately by [`resolve_streamid`].
fn streamid_fields(sid: &str) -> (Mode, Option<String>) {
    let body = sid.strip_prefix("#!::").unwrap_or(sid);
    let mut mode = Mode::Publish;
    let mut token = None;
    for kv in body.split(',') {
        if let Some(m) = kv.strip_prefix("m=") {
            mode = if m.eq_ignore_ascii_case("request") {
                Mode::Request
            } else {
                Mode::Publish
            };
        } else if let Some(t) = kv.strip_prefix("t=").or_else(|| kv.strip_prefix("u=")) {
            if !t.is_empty() {
                token = Some(t.to_string());
            }
        }
    }
    (mode, token)
}

/// Answer a handshake datagram, recovering egress/ingest key material on an
/// encrypted conclusion.
#[cfg(feature = "srt-encrypt")]
fn answer(dg: &[u8], pass: Option<&str>, km: &mut Option<KeyMaterial>) -> Option<Vec<u8>> {
    match pass {
        Some(p) => {
            let (reply, got) = handshake::respond_with_km(dg, p.as_bytes())?;
            if got.is_some() {
                *km = got;
            }
            Some(reply)
        }
        None => handshake::respond(dg),
    }
}

#[cfg(not(feature = "srt-encrypt"))]
fn answer(dg: &[u8]) -> Option<Vec<u8>> {
    handshake::respond(dg)
}

/// Drive one connection from handshake to teardown.
pub(super) async fn run(cfg: ConnConfig, mut rx: mpsc::Receiver<Vec<u8>>) {
    let ConnConfig {
        socket,
        peer,
        ctx,
        playback,
        gate,
        default_key,
        #[cfg(feature = "srt-encrypt")]
        passphrase,
        shutdown,
    } = cfg;

    let mut caller_id: u32 = 0;
    let mut streamid: Option<String> = None;
    #[cfg(feature = "srt-encrypt")]
    let mut key_material: Option<KeyMaterial> = None;
    // A data packet that arrives before a streamid (publish without streamid):
    // stashed so the publish loop processes it first.
    let mut first_data: Option<Vec<u8>> = None;

    // ── Handshake phase ──────────────────────────────────────────────────────
    'hs: loop {
        let dg = tokio::select! {
            _ = shutdown.cancelled() => return,
            d = tokio::time::timeout(IDLE_TIMEOUT, rx.recv()) => match d {
                Ok(Some(d)) => d,
                _ => return, // idle/closed
            }
        };
        match SrtPacket::parse(&dg) {
            Some(SrtPacket::Control {
                control_type: ControlType::Handshake,
                ..
            }) => {
                #[cfg(feature = "srt-encrypt")]
                let reply = answer(&dg, passphrase.as_deref(), &mut key_material);
                #[cfg(not(feature = "srt-encrypt"))]
                let reply = answer(&dg);
                if let Some(reply) = reply {
                    let _ = socket.send_to(&reply, peer).await;
                    if let Some(h) = handshake::SrtHandshake::parse(&dg) {
                        caller_id = h.socket_id;
                    }
                    if let Some(sid) = handshake::stream_id(&dg) {
                        streamid = Some(sid);
                        break 'hs; // mode is now known
                    }
                }
            }
            Some(SrtPacket::Data { .. }) => {
                // Publish with no streamid: fall back to the default key.
                first_data = Some(dg);
                break 'hs;
            }
            _ => {} // ACK/NAK/keepalive before setup — ignore
        }
    }

    let (mode, token) = match &streamid {
        Some(sid) => streamid_fields(sid),
        None => (Mode::Publish, None),
    };
    let key = match &streamid {
        Some(sid) => resolve_streamid(&default_key, sid),
        None => default_key.clone(),
    };

    match mode {
        Mode::Publish => {
            run_publish(
                &socket,
                peer,
                caller_id,
                &ctx,
                key,
                token,
                first_data,
                &shutdown,
                &mut rx,
                #[cfg(feature = "srt-encrypt")]
                key_material,
            )
            .await
        }
        Mode::Request => {
            let Some(playback) = playback else {
                debug!(%peer, "srt request but egress disabled");
                return;
            };
            // Egress gate: per-app SRT-egress toggle + play token (from streamid).
            let allowed = match gate.as_ref() {
                Some(g) => g(key.clone(), token.clone(), Some(peer)).await,
                None => true,
            };
            if !allowed {
                debug!(%peer, %key, "srt request denied by egress gate");
                return;
            }
            run_request(
                &socket,
                peer,
                caller_id,
                playback,
                key,
                &shutdown,
                &mut rx,
                #[cfg(feature = "srt-encrypt")]
                key_material,
            )
            .await
        }
    }
}

/// Demux a (reassembled, decrypted) TS payload and publish any access units.
fn publish_payload(demux: &mut TsDemuxer, sess: &PublishSession, payload: &[u8]) -> bool {
    for au in demux.push(payload) {
        if au.codec == CodecId::Unknown {
            continue;
        }
        let pts = au.pts_ms;
        let mut frame = match au.kind {
            TsTrackKind::Video => MediaFrame::new_video(pts, pts, au.data, au.codec, au.keyframe),
            TsTrackKind::Audio => MediaFrame::new_audio(pts, au.data, au.codec),
        };
        if au.is_config {
            frame.flags |= crate::FrameFlags::CONFIG;
        }
        if sess.publish_frame(frame).is_err() {
            return false;
        }
    }
    true
}

#[allow(clippy::too_many_arguments)]
async fn run_publish(
    socket: &Arc<UdpSocket>,
    peer: SocketAddr,
    caller_id: u32,
    ctx: &IngestContext,
    key: StreamKey,
    token: Option<String>,
    first_data: Option<Vec<u8>>,
    shutdown: &CancellationToken,
    rx: &mut mpsc::Receiver<Vec<u8>>,
    #[cfg(feature = "srt-encrypt")] key_material: Option<KeyMaterial>,
) {
    // Admission: tag the ingest protocol (so the per-app SRT toggle / publish
    // token are enforced) and carry the streamid token as the credential.
    let mut creds = crate::auth::Credentials::default();
    creds.params.push(("proto".into(), "srt".into()));
    creds.addr = Some(peer);
    creds.token = token;
    let session = match ctx.open_publish_checked(key.clone(), &creds).await {
        Ok(s) => s,
        Err(e) => {
            debug!(%peer, %key, error = %e, "srt publish rejected");
            return;
        }
    };
    info!(%peer, %key, "srt publish started");

    let mut demux = TsDemuxer::new();
    let mut receiver = Receiver::new(ARQ_WINDOW);
    let mut ack_no: u32 = 0;
    let start = Instant::now();
    let mut control = tokio::time::interval(CONTROL_INTERVAL);
    control.set_missed_tick_behavior(tokio::time::MissedTickBehavior::Delay);

    // Process a data packet that preceded the streamid, if any.
    let mut pending = first_data;

    loop {
        let dg = if let Some(d) = pending.take() {
            d
        } else {
            tokio::select! {
                _ = shutdown.cancelled() => break,
                _ = control.tick() => {
                    let ts = start.elapsed().as_micros() as u32;
                    if let Some(ack) = receiver.ack_seq() {
                        let _ = socket.send_to(&arq::build_ack(ack_no, ack, ts, caller_id), peer).await;
                        ack_no = ack_no.wrapping_add(1);
                    }
                    let missing = receiver.missing();
                    if !missing.is_empty() {
                        let _ = socket.send_to(&arq::build_nak(&missing, ts, caller_id), peer).await;
                    }
                    for ready in receiver.relieve() {
                        if !publish_payload(&mut demux, &session, &ready) { return; }
                    }
                    continue;
                }
                d = tokio::time::timeout(IDLE_TIMEOUT, rx.recv()) => match d {
                    Ok(Some(d)) => d,
                    _ => break,
                }
            }
        };

        match SrtPacket::parse(&dg) {
            Some(SrtPacket::Control {
                control_type: ControlType::Handshake,
                ..
            }) => {
                // A re-sent handshake (our reply was lost): re-answer.
                #[cfg(feature = "srt-encrypt")]
                let mut km = None;
                #[cfg(feature = "srt-encrypt")]
                if let Some(reply) = answer(&dg, None, &mut km) {
                    let _ = socket.send_to(&reply, peer).await;
                }
                #[cfg(not(feature = "srt-encrypt"))]
                if let Some(reply) = answer(&dg) {
                    let _ = socket.send_to(&reply, peer).await;
                }
            }
            Some(SrtPacket::Data {
                sequence,
                key_flag,
                payload_offset,
                ..
            }) => {
                let payload = dg[payload_offset..].to_vec();
                #[cfg(feature = "srt-encrypt")]
                let payload = {
                    let mut payload = payload;
                    if key_flag != 0 {
                        match &key_material {
                            Some(km) => km.transform(sequence, &mut payload),
                            None => continue, // encrypted but no key
                        }
                    }
                    payload
                };
                #[cfg(not(feature = "srt-encrypt"))]
                if key_flag != 0 {
                    continue; // encrypted feed, no crypto built
                }
                for ready in receiver.push(sequence, payload) {
                    if !publish_payload(&mut demux, &session, &ready) {
                        return;
                    }
                }
            }
            _ => {}
        }
    }

    let _ = session.finish().await;
    info!(%peer, %key, "srt publish stopped");
}

#[allow(clippy::too_many_arguments)]
async fn run_request(
    socket: &Arc<UdpSocket>,
    peer: SocketAddr,
    caller_id: u32,
    playback: Arc<dyn PlaybackRegistry>,
    key: StreamKey,
    shutdown: &CancellationToken,
    rx: &mut mpsc::Receiver<Vec<u8>>,
    #[cfg(feature = "srt-encrypt")] key_material: Option<KeyMaterial>,
) {
    let handle = match playback.get_stream(&key) {
        Ok(h) => h,
        Err(e) => {
            debug!(%peer, %key, error = %e, "srt request: stream unavailable");
            return;
        }
    };
    info!(%peer, %key, "srt request (egress) started");

    let mut sub = handle.subscribe_resilient();
    let mut mux = MpegTsMuxer::new();
    if mux.start_segment().is_err() {
        return;
    }
    let start = Instant::now();
    let mut seq: u32 = 0;
    let mut msg: u32 = 0;
    let mut send_buf = SendBuffer::new(SEND_WINDOW);

    #[cfg(feature = "srt-encrypt")]
    let key_flag: u8 = if key_material.is_some() { 1 } else { 0 };
    #[cfg(not(feature = "srt-encrypt"))]
    let key_flag: u8 = 0;

    loop {
        tokio::select! {
            _ = shutdown.cancelled() => break,

            // Control feedback from the player (caller): retransmit on NAK,
            // release the send buffer on ACK.
            dg = rx.recv() => {
                let Some(dg) = dg else { break };
                match arq::control_type(&dg) {
                    Some(ControlType::Nak) => {
                        for pkt in send_buf.retransmit(&arq::parse_nak(&dg)) {
                            let _ = socket.send_to(&pkt, peer).await;
                        }
                    }
                    Some(ControlType::Ack) => {
                        if let Some(ack) = arq::parse_ack(&dg) {
                            send_buf.acknowledge(ack);
                        }
                        if let Some(ack_no) = arq::ack_seqno(&dg) {
                            let ts = start.elapsed().as_micros() as u32;
                            let _ = socket.send_to(&arq::build_ackack(ack_no, ts, caller_id), peer).await;
                        }
                    }
                    _ => {}
                }
            }

            frame = sub.recv() => {
                let Some(frame) = frame else { break }; // publisher ended
                if mux.write(&frame).is_err() {
                    break;
                }
                let Ok(Some(ts_bytes)) = mux.take_partial() else { continue };
                for piece in ts_bytes.chunks(TS_BYTES_PER_DATAGRAM) {
                    let ts = start.elapsed().as_micros() as u32;
                    let payload = piece.to_vec();
                    #[cfg(feature = "srt-encrypt")]
                    let payload = {
                        let mut payload = payload;
                        if let Some(km) = &key_material {
                            km.transform(seq, &mut payload);
                        }
                        payload
                    };
                    let pkt = build_data_packet(seq, msg, ts, caller_id, key_flag, false, &payload);
                    if socket.send_to(&pkt, peer).await.is_err() {
                        warn!(%peer, "srt egress send failed");
                        return;
                    }
                    send_buf.record(seq, pkt);
                    seq = seq.wrapping_add(1) & 0x7FFF_FFFF;
                    msg = msg.wrapping_add(1) & 0x03FF_FFFF;
                }
            }
        }
    }
    info!(%peer, %key, "srt request (egress) stopped");
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn streamid_fields_parse_mode_and_token() {
        let (m, t) = streamid_fields("#!::r=live/test,m=publish,t=secret");
        assert!(matches!(m, Mode::Publish));
        assert_eq!(t.as_deref(), Some("secret"));

        let (m, t) = streamid_fields("#!::r=live/test,m=request");
        assert!(matches!(m, Mode::Request));
        assert_eq!(t, None);

        // bare/no mode → publish
        let (m, _) = streamid_fields("live/test");
        assert!(matches!(m, Mode::Publish));
    }
}