opencv 0.22.0

Rust bindings for OpenCV
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
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211

use std::ffi::c_void;

use crate::{
    core::{_InputArray, _InputOutputArray, _OutputArray, Mat, MatExpr, UMat},
    Result,
    sys,
    types::{VectorOfMat, VectorOfUMat},
};

pub struct InputArray {
    #[doc(hidden)] pub(crate) ptr: *mut c_void
}

impl InputArray {
    #[inline]
    pub fn from_mat(m: &Mat) -> Result<Self> {
        let m = m.as_raw_Mat();
        cpp!(unsafe [m as "const Mat*"] -> sys::cv_return_value_const_void_X as "cv_return_value_void_X" {
            try {
                return { Error::Code::StsOk, NULL, new _InputArray(*m) };
            } CVRS_CATCH(cv_return_value_void_X)
        }).into_result()
            .map(|ptr| Self { ptr })
    }

    #[inline]
    pub fn from_mat_expr(m: &MatExpr) -> Result<Self> {
        let m = m.as_raw_MatExpr();
        cpp!(unsafe [m as "const MatExpr*"] -> sys::cv_return_value_const_void_X as "cv_return_value_void_X" {
            try {
                return { Error::Code::StsOk, NULL, new _InputArray(*m) };
            } CVRS_CATCH(cv_return_value_void_X)
        }).into_result()
            .map(|ptr| Self { ptr })
    }

    #[inline]
    pub fn from_mat_vec(m: &VectorOfMat) -> Result<Self> {
        let m = m.as_raw_VectorOfMat();
        cpp!(unsafe [m as "const std::vector<Mat>*"] -> sys::cv_return_value_const_void_X as "cv_return_value_void_X" {
            try {
                return { Error::Code::StsOk, NULL, new _InputArray(*m) };
            } CVRS_CATCH(cv_return_value_void_X)
        }).into_result()
            .map(|ptr| Self { ptr })
    }

    #[inline]
    pub fn from_f64(val: &f64) -> Result<Self> {
        cpp!(unsafe [val as "const double*"] -> sys::cv_return_value_const_void_X as "cv_return_value_void_X" {
            try {
                return { Error::Code::StsOk, NULL, new _InputArray(*val) };
            } CVRS_CATCH(cv_return_value_void_X)
        }).into_result()
            .map(|ptr| Self { ptr })
    }

    #[inline]
    pub fn from_umat(m: &UMat) -> Result<Self> {
        let m = m.as_raw_UMat();
        cpp!(unsafe [m as "const UMat*"] -> sys::cv_return_value_const_void_X as "cv_return_value_void_X" {
            try {
                return { Error::Code::StsOk, NULL, new _InputArray(*m) };
            } CVRS_CATCH(cv_return_value_void_X)
        }).into_result()
            .map(|ptr| Self { ptr })
    }

    #[inline]
    pub fn from_umat_vec(m: &VectorOfUMat) -> Result<Self> {
        let m = m.as_raw_VectorOfUMat();
        cpp!(unsafe [m as "const std::vector<UMat>*"] -> sys::cv_return_value_const_void_X as "cv_return_value_void_X" {
            try {
                return { Error::Code::StsOk, NULL, new _InputArray(*m) };
            } CVRS_CATCH(cv_return_value_void_X)
        }).into_result()
            .map(|ptr| Self { ptr })
    }
}

impl _InputArray for InputArray {
    fn as_raw__InputArray(&self) -> *mut c_void {
        self.ptr
    }
}

impl Drop for InputArray {
    fn drop(&mut self) {
        let me = self.as_raw__InputArray();
        cpp!(unsafe [me as "cv::_InputArray*"] {
            delete me;
        })
    }
}

/// Trait to serve as a replacement for `InputArray` in C++ OpenCV
///
/// You can pass references to the types implementing this trait everywhere where OpenCV API expects
/// `InputArray` or `InputArrayOfArrays`.
///
/// More info in [OpenCV docs](https://docs.opencv.org/master/d4/d32/classcv_1_1__InputArray.html#details).
pub trait ToInputArray {
    fn input_array(&self) -> Result<InputArray>;
}

impl ToInputArray for f64 {
    #[inline]
    fn input_array(&self) -> Result<InputArray> {
        InputArray::from_f64(self)
    }
}

impl ToInputArray for &f64 {
    #[inline]
    fn input_array(&self) -> Result<InputArray> {
        (*self).input_array()
    }
}

pub struct OutputArray {
    #[doc(hidden)] pub(crate) ptr: *mut c_void
}

impl OutputArray {
    #[inline]
    pub fn from_mat(m: &mut Mat) -> Result<Self> {
        let m = m.as_raw_Mat();
        cpp!(unsafe [m as "Mat*"] -> sys::cv_return_value_const_void_X as "cv_return_value_void_X" {
            try {
                return { Error::Code::StsOk, NULL, new _OutputArray(*m) };
            } CVRS_CATCH(cv_return_value_void_X)
        }).into_result()
            .map(|ptr| Self { ptr })
    }

    #[inline]
    pub fn from_mat_vec(m: &mut VectorOfMat) -> Result<Self> {
        let m = m.as_raw_VectorOfMat();
        cpp!(unsafe [m as "std::vector<Mat>*"] -> sys::cv_return_value_const_void_X as "cv_return_value_void_X" {
            try {
                return { Error::Code::StsOk, NULL, new _OutputArray(*m) };
            } CVRS_CATCH(cv_return_value_void_X)
        }).into_result()
            .map(|ptr| Self { ptr })
    }

    #[inline]
    pub fn from_umat(m: &mut UMat) -> Result<Self> {
        let m = m.as_raw_UMat();
        cpp!(unsafe [m as "UMat*"] -> sys::cv_return_value_const_void_X as "cv_return_value_void_X" {
            try {
                return { Error::Code::StsOk, NULL, new _OutputArray(*m) };
            } CVRS_CATCH(cv_return_value_void_X)
        }).into_result()
            .map(|ptr| Self { ptr })
    }

    #[inline]
    pub fn from_umat_vec(m: &mut VectorOfUMat) -> Result<Self> {
        let m = m.as_raw_VectorOfUMat();
        cpp!(unsafe [m as "std::vector<UMat>*"] -> sys::cv_return_value_const_void_X as "cv_return_value_void_X" {
            try {
                return { Error::Code::StsOk, NULL, new _OutputArray(*m) };
            } CVRS_CATCH(cv_return_value_void_X)
        }).into_result()
            .map(|ptr| Self { ptr })
    }
}

impl _InputArray for OutputArray {
    fn as_raw__InputArray(&self) -> *mut c_void {
        self.ptr
    }
}

impl _OutputArray for OutputArray {
    fn as_raw__OutputArray(&self) -> *mut c_void {
        self.as_raw__InputArray()
    }
}

impl Drop for OutputArray {
    fn drop(&mut self) {
        let me = self.as_raw__OutputArray();
        cpp!(unsafe [me as "cv::_OutputArray*"] {
            delete me;
        })
    }
}

/// Trait to serve as a replacement for `OutputArray` in C++ OpenCV
///
/// You can pass reference to the type implementing this trait everywhere where OpenCV API expects
/// `OutputArray` or `OutputArrayOfArrays`.
///
/// More info in [OpenCV docs](https://docs.opencv.org/master/d2/d9e/classcv_1_1__OutputArray.html#details).
pub trait ToOutputArray {
    fn output_array(&mut self) -> Result<OutputArray>;
}

pub type InputOutputArray = _InputOutputArray;

/// Trait to serve as a replacement for `InputOutputArray` in C++ OpenCV
///
/// You can pass reference to the type implementing this trait everywhere where OpenCV API expects
/// `InputOutputArray` or `InputOutputArrayOfArrays`.
///
/// For more info see comments for `ToInputArray` and `ToOutputArray`.
pub trait ToInputOutputArray {
    fn input_output_array(&mut self) -> Result<InputOutputArray>;
}