machine-vision-formats 0.1.7

Types and traits for working with raw image data from machine vision cameras
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153

//! References to image data

use crate::{ImageBufferMutRef, ImageBufferRef, ImageData, ImageMutData, PixelFormat, Stride};

// -----

/// A view of image to have pixel format `FMT`.
pub struct ImageRef<'a, FMT: PixelFormat> {
    buf: &'a [u8],
    width: u32,
    height: u32,
    stride: usize,
    fmt: std::marker::PhantomData<FMT>,
}

impl<'a, FMT: PixelFormat> ImageRef<'a, FMT> {
    /// Use a `&[u8]` slice as the backing store for an ImageRef.
    ///
    /// Returns None if the buffer is not large enough to store an image of the
    /// desired properties.
    pub fn new(width: u32, height: u32, stride: usize, buf: &'a [u8]) -> Option<Self> {
        let fmt = crate::pixel_format::pixfmt::<FMT>().unwrap();
        let min_stride = fmt.bits_per_pixel() as usize * width as usize / 8;

        if height == 0 {
            return None;
        }
        let sz = stride * (height as usize - 1) + min_stride;

        if buf.len() < sz {
            return None;
        }
        Some(Self {
            width,
            height,
            stride,
            buf,
            fmt: std::marker::PhantomData,
        })
    }
}

impl<F: PixelFormat> std::fmt::Debug for ImageRef<'_, F> {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        f.debug_struct("ImageRef")
            .field("fmt", &self.fmt)
            .field("width", &self.width)
            .field("height", &self.height)
            .field("stride", &self.stride)
            .finish_non_exhaustive()
    }
}

impl<FMT: PixelFormat> ImageData<FMT> for ImageRef<'_, FMT> {
    fn width(&self) -> u32 {
        self.width
    }
    fn height(&self) -> u32 {
        self.height
    }
    fn buffer_ref(&self) -> ImageBufferRef<'_, FMT> {
        ImageBufferRef::new(self.buf)
    }
    #[cfg(any(feature = "std", feature = "alloc"))]
    fn buffer(self) -> crate::ImageBuffer<FMT> {
        // copy the data
        self.buffer_ref().to_buffer()
    }
}

impl<FMT: PixelFormat> Stride for ImageRef<'_, FMT> {
    fn stride(&self) -> usize {
        self.stride
    }
}

// -----

/// A view of mutable image to have pixel format `FMT`.
pub struct ImageRefMut<'a, FMT: PixelFormat> {
    buf: &'a mut [u8],
    width: u32,
    height: u32,
    stride: usize,
    fmt: std::marker::PhantomData<FMT>,
}

impl<'a, FMT: PixelFormat> ImageRefMut<'a, FMT> {
    /// Use a `&mut [u8]` slice as the backing store for an ImageRefMut.
    ///
    /// Returns None if the buffer is not large enough to store an image of the
    /// desired properties.
    pub fn new(width: u32, height: u32, stride: usize, buf: &'a mut [u8]) -> Option<Self> {
        let fmt = crate::pixel_format::pixfmt::<FMT>().unwrap();
        let min_stride = fmt.bits_per_pixel() as usize * width as usize / 8;

        if height == 0 {
            return None;
        }
        let sz = stride * (height as usize - 1) + min_stride;

        if buf.len() < sz {
            return None;
        }
        Some(Self {
            width,
            height,
            stride,
            buf,
            fmt: std::marker::PhantomData,
        })
    }
}

impl<F: PixelFormat> std::fmt::Debug for ImageRefMut<'_, F> {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        f.debug_struct("ImageRefMut")
            .field("fmt", &self.fmt)
            .field("width", &self.width)
            .field("height", &self.height)
            .field("stride", &self.stride)
            .finish_non_exhaustive()
    }
}

impl<FMT: PixelFormat> ImageData<FMT> for ImageRefMut<'_, FMT> {
    fn width(&self) -> u32 {
        self.width
    }
    fn height(&self) -> u32 {
        self.height
    }
    fn buffer_ref(&self) -> ImageBufferRef<'_, FMT> {
        ImageBufferRef::new(self.buf)
    }
    #[cfg(any(feature = "std", feature = "alloc"))]
    fn buffer(self) -> crate::ImageBuffer<FMT> {
        // copy the data
        self.buffer_ref().to_buffer()
    }
}

impl<FMT: PixelFormat> ImageMutData<FMT> for ImageRefMut<'_, FMT> {
    fn buffer_mut_ref(&mut self) -> ImageBufferMutRef<'_, FMT> {
        ImageBufferMutRef::new(self.buf)
    }
}

impl<FMT: PixelFormat> Stride for ImageRefMut<'_, FMT> {
    fn stride(&self) -> usize {
        self.stride
    }
}