gst-plugins-rs/generic/threadshare/examples/standalone/sink/stats.rs

use gst::prelude::*;
use std::time::{Duration, Instant};

#[cfg(feature = "tuning")]
use gstthreadshare::runtime::Context;

use super::CAT;

const LOG_PERIOD: Duration = Duration::from_secs(20);

#[derive(Debug, Default)]
pub struct Stats {
    ramp_up_instant: Option<Instant>,
    log_start_instant: Option<Instant>,
    last_delta_instant: Option<Instant>,
    max_buffers: Option<f32>,
    buffer_count: f32,
    buffer_count_delta: f32,
    latency_sum: f32,
    latency_square_sum: f32,
    latency_sum_delta: f32,
    latency_square_sum_delta: f32,
    latency_min: Duration,
    latency_min_delta: Duration,
    latency_max: Duration,
    latency_max_delta: Duration,
    interval_sum: f32,
    interval_square_sum: f32,
    interval_sum_delta: f32,
    interval_square_sum_delta: f32,
    interval_min: Duration,
    interval_min_delta: Duration,
    interval_max: Duration,
    interval_max_delta: Duration,
    interval_late_warn: Duration,
    interval_late_count: f32,
    interval_late_count_delta: f32,
    #[cfg(feature = "tuning")]
    parked_duration_init: Duration,
}

impl Stats {
    pub fn new(max_buffers: Option<u32>, interval_late_warn: Duration) -> Self {
        Stats {
            max_buffers: max_buffers.map(|max_buffers| max_buffers as f32),
            interval_late_warn,
            ..Default::default()
        }
    }

    pub fn start(&mut self) {
        self.buffer_count = 0.0;
        self.buffer_count_delta = 0.0;
        self.latency_sum = 0.0;
        self.latency_square_sum = 0.0;
        self.latency_sum_delta = 0.0;
        self.latency_square_sum_delta = 0.0;
        self.latency_min = Duration::MAX;
        self.latency_min_delta = Duration::MAX;
        self.latency_max = Duration::ZERO;
        self.latency_max_delta = Duration::ZERO;
        self.interval_sum = 0.0;
        self.interval_square_sum = 0.0;
        self.interval_sum_delta = 0.0;
        self.interval_square_sum_delta = 0.0;
        self.interval_min = Duration::MAX;
        self.interval_min_delta = Duration::MAX;
        self.interval_max = Duration::ZERO;
        self.interval_max_delta = Duration::ZERO;
        self.interval_late_count = 0.0;
        self.interval_late_count_delta = 0.0;
        self.last_delta_instant = None;
        self.log_start_instant = None;

        self.ramp_up_instant = Some(Instant::now());
        gst::info!(CAT, "First stats logs in {:2?}", 2 * LOG_PERIOD);
    }

    pub fn is_active(&mut self) -> bool {
        if let Some(ramp_up_instant) = self.ramp_up_instant {
            if ramp_up_instant.elapsed() < LOG_PERIOD {
                return false;
            }

            self.ramp_up_instant = None;
            gst::info!(CAT, "Ramp up complete. Stats logs in {:2?}", LOG_PERIOD);
            self.log_start_instant = Some(Instant::now());
            self.last_delta_instant = self.log_start_instant;

            #[cfg(feature = "tuning")]
            {
                self.parked_duration_init = Context::current().unwrap().parked_duration();
            }
        }

        use std::cmp::Ordering::*;
        match self.max_buffers.opt_cmp(self.buffer_count) {
            Some(Equal) => {
                self.log_global();
                self.buffer_count += 1.0;
                false
            }
            Some(Less) => false,
            _ => true,
        }
    }

    pub fn add_buffer(&mut self, latency: Duration, interval: Duration) {
        if !self.is_active() {
            return;
        }

        self.buffer_count += 1.0;
        self.buffer_count_delta += 1.0;

        // Latency
        let latency_f32 = latency.as_nanos() as f32;
        let latency_square = latency_f32.powi(2);

        self.latency_sum += latency_f32;
        self.latency_square_sum += latency_square;
        self.latency_min = self.latency_min.min(latency);
        self.latency_max = self.latency_max.max(latency);

        self.latency_sum_delta += latency_f32;
        self.latency_square_sum_delta += latency_square;
        self.latency_min_delta = self.latency_min_delta.min(latency);
        self.latency_max_delta = self.latency_max_delta.max(latency);

        // Interval
        let interval_f32 = interval.as_nanos() as f32;
        let interval_square = interval_f32.powi(2);

        self.interval_sum += interval_f32;
        self.interval_square_sum += interval_square;
        self.interval_min = self.interval_min.min(interval);
        self.interval_max = self.interval_max.max(interval);

        self.interval_sum_delta += interval_f32;
        self.interval_square_sum_delta += interval_square;
        self.interval_min_delta = self.interval_min_delta.min(interval);
        self.interval_max_delta = self.interval_max_delta.max(interval);

        if interval > self.interval_late_warn {
            self.interval_late_count += 1.0;
            self.interval_late_count_delta += 1.0;
        }

        let delta_duration = match self.last_delta_instant {
            Some(last_delta) => last_delta.elapsed(),
            None => return,
        };

        if delta_duration < LOG_PERIOD {
            return;
        }

        self.last_delta_instant = Some(Instant::now());

        gst::info!(CAT, "Delta stats:");
        let interval_mean = self.interval_sum_delta / self.buffer_count_delta;
        let interval_std_dev = f32::sqrt(
            self.interval_square_sum_delta / self.buffer_count_delta - interval_mean.powi(2),
        );

        gst::info!(
            CAT,
            "o interval: mean {:4.2?} σ {:4.1?} [{:4.1?}, {:4.1?}]",
            Duration::from_nanos(interval_mean as u64),
            Duration::from_nanos(interval_std_dev as u64),
            self.interval_min_delta,
            self.interval_max_delta,
        );

        if self.interval_late_count_delta > f32::EPSILON {
            gst::warning!(
                CAT,
                "o {:5.2}% late buffers",
                100f32 * self.interval_late_count_delta / self.buffer_count_delta
            );
        }

        self.interval_sum_delta = 0.0;
        self.interval_square_sum_delta = 0.0;
        self.interval_min_delta = Duration::MAX;
        self.interval_max_delta = Duration::ZERO;
        self.interval_late_count_delta = 0.0;

        let latency_mean = self.latency_sum_delta / self.buffer_count_delta;
        let latency_std_dev = f32::sqrt(
            self.latency_square_sum_delta / self.buffer_count_delta - latency_mean.powi(2),
        );

        gst::info!(
            CAT,
            "o latency: mean {:4.2?} σ {:4.1?} [{:4.1?}, {:4.1?}]",
            Duration::from_nanos(latency_mean as u64),
            Duration::from_nanos(latency_std_dev as u64),
            self.latency_min_delta,
            self.latency_max_delta,
        );

        self.latency_sum_delta = 0.0;
        self.latency_square_sum_delta = 0.0;
        self.latency_min_delta = Duration::MAX;
        self.latency_max_delta = Duration::ZERO;

        self.buffer_count_delta = 0.0;
    }

    pub fn log_global(&mut self) {
        if self.buffer_count < 1.0 {
            return;
        }

        let _log_start = if let Some(log_start) = self.log_start_instant {
            log_start
        } else {
            return;
        };

        gst::info!(CAT, "Global stats:");

        #[cfg(feature = "tuning")]
        {
            let duration = _log_start.elapsed();
            let parked_duration =
                Context::current().unwrap().parked_duration() - self.parked_duration_init;
            gst::info!(
                CAT,
                "o parked: {parked_duration:4.2?} ({:5.2?}%)",
                (parked_duration.as_nanos() as f32 * 100.0 / duration.as_nanos() as f32)
            );
        }

        let interval_mean = self.interval_sum / self.buffer_count;
        let interval_std_dev =
            f32::sqrt(self.interval_square_sum / self.buffer_count - interval_mean.powi(2));

        gst::info!(
            CAT,
            "o interval: mean {:4.2?} σ {:4.1?} [{:4.1?}, {:4.1?}]",
            Duration::from_nanos(interval_mean as u64),
            Duration::from_nanos(interval_std_dev as u64),
            self.interval_min,
            self.interval_max,
        );

        if self.interval_late_count > f32::EPSILON {
            gst::warning!(
                CAT,
                "o {:5.2}% late buffers",
                100f32 * self.interval_late_count / self.buffer_count
            );
        }

        let latency_mean = self.latency_sum / self.buffer_count;
        let latency_std_dev =
            f32::sqrt(self.latency_square_sum / self.buffer_count - latency_mean.powi(2));

        gst::info!(
            CAT,
            "o latency: mean {:4.2?} σ {:4.1?} [{:4.1?}, {:4.1?}]",
            Duration::from_nanos(latency_mean as u64),
            Duration::from_nanos(latency_std_dev as u64),
            self.latency_min,
            self.latency_max,
        );
    }
}