opencv-rs-core 0.1.0

Runtime-agnostic domain types and ports for opencv-rs (no FFI dependency)
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

//! Image encoder port.

use crate::{ImageEncodingError, MatView};

/// The output container an [`ImageEncoderPort`] should produce.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum EncodingKind {
    /// JPEG-encoded bytes.
    Jpeg,
    /// WebP-encoded bytes.
    Webp,
    /// No encoding; the encoder should return the raw pixel bytes verbatim.
    None,
}

impl EncodingKind {
    /// Human-readable short name for the encoding.
    pub const fn name(self) -> &'static str {
        match self {
            Self::Jpeg => "jpeg",
            Self::Webp => "webp",
            Self::None => "none",
        }
    }
}

/// Encodes a [`MatView`] into a byte buffer in one of the [`EncodingKind`]s.
pub trait ImageEncoderPort: Send + Sync {
    /// Encode `frame` using `kind` and return the resulting bytes.
    fn encode(
        &self,
        frame: &dyn MatView,
        kind: EncodingKind,
    ) -> Result<Vec<u8>, ImageEncodingError>;
}

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

    #[test]
    fn encoding_kind_names() {
        assert_eq!(EncodingKind::Jpeg.name(), "jpeg");
        assert_eq!(EncodingKind::Webp.name(), "webp");
        assert_eq!(EncodingKind::None.name(), "none");
    }
}