One-KVM/src/video/capture/status.rs

//! Shared capture status and error classification helpers.

use std::io;

#[cfg(any(
    test,
    all(target_os = "linux", any(target_arch = "aarch64", target_arch = "arm"))
))]
use crate::video::device::VideoControlMode;
use crate::video::signal::SignalStatus;

#[cfg(any(
    test,
    all(target_os = "linux", any(target_arch = "aarch64", target_arch = "arm"))
))]
pub(crate) fn capture_recovery_status(
    control_mode: VideoControlMode,
    error: &io::Error,
) -> SignalStatus {
    if control_mode == VideoControlMode::Configurable && error.kind() == io::ErrorKind::TimedOut {
        return SignalStatus::UvcCaptureStall;
    }
    match classify_capture_io_error(error) {
        CaptureIoErrorKind::TransientSignal {
            status: Some(status),
        } => status,
        _ => SignalStatus::NoSignal,
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum CaptureIoErrorKind {
    DeviceLost,
    TransientSignal { status: Option<SignalStatus> },
    Other,
}

pub fn signal_status_from_capture_kind(kind: &str) -> SignalStatus {
    SignalStatus::from_str(kind).unwrap_or(SignalStatus::NoSignal)
}

pub fn classify_capture_io_error(err: &io::Error) -> CaptureIoErrorKind {
    match err.raw_os_error() {
        // ENXIO / ENODEV / ESHUTDOWN: the device node or endpoint is gone.
        Some(6) | Some(19) | Some(108) => CaptureIoErrorKind::DeviceLost,
        // EIO / EPIPE: source or transport glitched; EPROTO is common for UVC USB.
        Some(5) | Some(32) => CaptureIoErrorKind::TransientSignal { status: None },
        Some(71) => CaptureIoErrorKind::TransientSignal {
            status: Some(SignalStatus::UvcUsbError),
        },
        _ => CaptureIoErrorKind::Other,
    }
}

pub fn is_device_lost_message(message: &str) -> bool {
    message.contains("No such file or directory")
        || message.contains("No such device")
        || message.contains("os error 2")
        || message.contains("ENODEV")
        || message.contains("ENXIO")
        || message.contains("ESHUTDOWN")
}

pub fn capture_error_log_key(err: &io::Error) -> String {
    let message = err.to_string();
    if message.contains("dqbuf failed") && message.contains("EINVAL") {
        "capture_dqbuf_einval".to_string()
    } else if message.contains("dqbuf failed") {
        "capture_dqbuf".to_string()
    } else {
        format!("capture_{:?}", err.kind())
    }
}

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

    #[test]
    fn recovery_distinguishes_uvc_stalls_from_hdmi_signal_loss() {
        let timeout = io::Error::from(io::ErrorKind::TimedOut);
        assert_eq!(
            capture_recovery_status(VideoControlMode::Configurable, &timeout),
            SignalStatus::UvcCaptureStall
        );
        assert_eq!(
            capture_recovery_status(VideoControlMode::SourceFollowing, &timeout),
            SignalStatus::NoSignal
        );
        assert_eq!(
            capture_recovery_status(
                VideoControlMode::Configurable,
                &io::Error::from_raw_os_error(71)
            ),
            SignalStatus::UvcUsbError
        );
        assert_eq!(
            capture_recovery_status(
                VideoControlMode::SourceFollowing,
                &io::Error::from_raw_os_error(5)
            ),
            SignalStatus::NoSignal
        );
    }

    #[test]
    fn maps_known_signal_status_strings() {
        assert_eq!(
            signal_status_from_capture_kind("out_of_range"),
            SignalStatus::OutOfRange
        );
        assert_eq!(
            signal_status_from_capture_kind("unknown"),
            SignalStatus::NoSignal
        );
    }

    #[test]
    fn classifies_source_change_log_keys() {
        let err = io::Error::other("dqbuf failed: EINVAL");
        assert_eq!(capture_error_log_key(&err), "capture_dqbuf_einval");

        let err = io::Error::new(io::ErrorKind::TimedOut, "capture timeout");
        assert_eq!(capture_error_log_key(&err), "capture_TimedOut");
    }
}