vidaptive 0.1.0

Responsive rate control for real-time video
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

//! Encoder pause when queue delay exceeds τ.

use core::time::Duration;

use crate::config::VidaptiveConfig;

/// Pause encoding when the oldest queued packet waits too long.
#[derive(Debug, Clone)]
pub(crate) struct Safeguards {
    tau_pause: Duration,
    paused: bool,
}

impl Safeguards {
    /// Creates safeguards from configuration.
    #[must_use]
    pub(crate) fn new(config: &VidaptiveConfig) -> Self {
        Self {
            tau_pause: config.tau_pause(),
            paused: false,
        }
    }

    /// Updates pause state from queue age and whether the pacer queue is empty.
    pub(crate) fn update(&mut self, oldest_queued_age: Option<Duration>, queue_empty: bool) {
        if queue_empty {
            self.paused = false;
            return;
        }

        let Some(age) = oldest_queued_age else {
            self.paused = false;
            return;
        };

        self.paused = age > self.tau_pause;
    }

    /// Whether the encoder should pause.
    #[must_use]
    pub(crate) const fn is_paused(&self) -> bool {
        self.paused
    }
}