depthai 0.1.3

Experimental Rust bindings and idiomatic wrapper for Luxonis DepthAI-Core v3.
Documentation
use std::ptr;
use std::time::Duration;

use autocxx::c_int;
use depthai_sys::{depthai, DaiDataQueue, DaiEncodedFrame};

use crate::error::{clear_error_flag, last_error, take_error_if_any, Result};

#[repr(i32)]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum EncodedFrameProfile {
    Jpeg = 0,
    Avc = 1,
    Hevc = 2,
}

impl EncodedFrameProfile {
    pub fn from_raw(value: i32) -> Option<Self> {
        match value {
            0 => Some(Self::Jpeg),
            1 => Some(Self::Avc),
            2 => Some(Self::Hevc),
            _ => None,
        }
    }
}

#[repr(i32)]
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum EncodedFrameType {
    I = 0,
    P = 1,
    B = 2,
    Unknown = 3,
}

impl EncodedFrameType {
    pub fn from_raw(value: i32) -> Option<Self> {
        match value {
            0 => Some(Self::I),
            1 => Some(Self::P),
            2 => Some(Self::B),
            3 => Some(Self::Unknown),
            _ => None,
        }
    }
}

pub struct EncodedFrame {
    handle: DaiEncodedFrame,
}

impl Drop for EncodedFrame {
    fn drop(&mut self) {
        if !self.handle.is_null() {
            unsafe { depthai::dai_encoded_frame_release(self.handle) };
            self.handle = ptr::null_mut();
        }
    }
}

impl EncodedFrame {
    pub(crate) fn from_handle(handle: DaiEncodedFrame) -> Self {
        Self { handle }
    }

    pub fn width(&self) -> u32 {
        let raw: i32 = unsafe { depthai::dai_encoded_frame_get_width(self.handle) }.into();
        raw as u32
    }

    pub fn height(&self) -> u32 {
        let raw: i32 = unsafe { depthai::dai_encoded_frame_get_height(self.handle) }.into();
        raw as u32
    }

    pub fn profile(&self) -> Option<EncodedFrameProfile> {
        let raw: i32 = unsafe { depthai::dai_encoded_frame_get_profile(self.handle) }.into();
        EncodedFrameProfile::from_raw(raw)
    }

    pub fn frame_type(&self) -> Option<EncodedFrameType> {
        let raw: i32 = unsafe { depthai::dai_encoded_frame_get_frame_type(self.handle) }.into();
        EncodedFrameType::from_raw(raw)
    }

    pub fn quality(&self) -> u32 {
        let raw: i32 = unsafe { depthai::dai_encoded_frame_get_quality(self.handle) }.into();
        raw as u32
    }

    pub fn bitrate(&self) -> u32 {
        let raw: i32 = unsafe { depthai::dai_encoded_frame_get_bitrate(self.handle) }.into();
        raw as u32
    }

    pub fn lossless(&self) -> bool {
        unsafe { depthai::dai_encoded_frame_get_lossless(self.handle) }
    }

    pub fn instance_num(&self) -> u32 {
        let raw: i32 = unsafe { depthai::dai_encoded_frame_get_instance_num(self.handle) }.into();
        raw as u32
    }

    pub fn data_len(&self) -> usize {
        unsafe { depthai::dai_encoded_frame_get_data_size(self.handle) }
    }

    /// Returns the encoded bytes.
    ///
    /// DepthAI's `EncodedFrame` may use the `frameOffset/frameSize` fields to indicate the
    /// actual frame sub-slice within the internal buffer. When those fields are usable,
    /// this returns exactly that range; otherwise it returns the full buffer.
    pub fn bytes(&self) -> Vec<u8> {
        let len = self.data_len();
        if len == 0 {
            return Vec::new();
        }
        let ptr = unsafe { depthai::dai_encoded_frame_get_data(self.handle) };
        if ptr.is_null() {
            return Vec::new();
        }

        let all = unsafe { std::slice::from_raw_parts(ptr as *const u8, len) };

        let offset = unsafe { depthai::dai_encoded_frame_get_frame_offset(self.handle) } as usize;
        let size = unsafe { depthai::dai_encoded_frame_get_frame_size(self.handle) } as usize;

        if size > 0 && offset <= all.len() && offset.saturating_add(size) <= all.len() {
            all[offset..offset + size].to_vec()
        } else {
            all.to_vec()
        }
    }

    pub fn describe(&self) -> String {
        let prof = self.profile().map(|p| format!("{p:?}")).unwrap_or_else(|| "unknown".into());
        let ty = self
            .frame_type()
            .map(|t| format!("{t:?}"))
            .unwrap_or_else(|| "unknown".into());
        format!("{}x{} {prof} {ty} ({} bytes)", self.width(), self.height(), self.data_len())
    }
}

pub struct EncodedFrameQueue {
    handle: DaiDataQueue,
}

impl Drop for EncodedFrameQueue {
    fn drop(&mut self) {
        if !self.handle.is_null() {
            unsafe { depthai::dai_queue_delete(self.handle) };
            self.handle = ptr::null_mut();
        }
    }
}

impl EncodedFrameQueue {
    pub(crate) fn from_handle(handle: DaiDataQueue) -> Self {
        Self { handle }
    }

    pub fn blocking_next(&self, timeout: Option<Duration>) -> Result<Option<EncodedFrame>> {
        clear_error_flag();
        let timeout_ms = timeout.map(|d| d.as_millis() as i32).unwrap_or(-1);
        let frame = unsafe { depthai::dai_queue_get_encoded_frame(self.handle, c_int(timeout_ms)) };
        if frame.is_null() {
            if let Some(err) = take_error_if_any("failed to pull encoded frame") {
                Err(err)
            } else {
                Ok(None)
            }
        } else {
            Ok(Some(EncodedFrame::from_handle(frame)))
        }
    }

    pub fn try_next(&self) -> Result<Option<EncodedFrame>> {
        clear_error_flag();
        let frame = unsafe { depthai::dai_queue_try_get_encoded_frame(self.handle) };
        if frame.is_null() {
            if let Some(err) = take_error_if_any("failed to poll encoded frame") {
                Err(err)
            } else {
                Ok(None)
            }
        } else {
            Ok(Some(EncodedFrame::from_handle(frame)))
        }
    }

    pub(crate) fn handle(&self) -> DaiDataQueue {
        self.handle
    }

    pub(crate) fn into_raw(self) -> DaiDataQueue {
        let me = std::mem::ManuallyDrop::new(self);
        me.handle
    }
}

pub(crate) fn validate_nv12_dimensions(width: u32, height: u32) -> Result<()> {
    if width % 2 != 0 || height % 2 != 0 {
        return Err(last_error("NV12 frames must have even width and height"));
    }
    Ok(())
}