opencv 0.95.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

use std::ffi::{c_char, CStr};
use std::slice;

use crate::platform_types::size_t;

macro_rules! extern_container_arg {
	(nofail mut $name: ident) => {
		let mut $name = $name.opencv_into_extern_container_nofail();
	};
	(nofail $name: ident) => {
		let $name = $name.opencv_into_extern_container_nofail();
	};
	(mut $name: ident) => {
		let mut $name = $name.opencv_into_extern_container()?;
	};
	($name: ident) => {
		let $name = $name.opencv_into_extern_container()?;
	};
}

macro_rules! string_arg_output_send {
	(via $name_via: ident) => {
		let mut $name_via = ::std::ptr::null_mut();
	};
}

macro_rules! string_arg_output_receive {
	($name_via: ident => $name: ident) => {
		*$name = unsafe { $crate::templ::receive_string($name_via.cast()) };
	};
}

macro_rules! callback_arg {
	($tr_name: ident($($tr_arg_name: ident: $tr_arg_type: ty),*) -> $tr_ret: ty => $tr_userdata_name: ident in $callback_name: ident($($fw_arg_name: ident: $fw_arg_type: ty),*) -> $fw_ret: ty) => {
		unsafe extern "C" fn trampoline($($tr_arg_name: $tr_arg_type),*) -> $tr_ret {
			let callback: *mut Box<dyn FnMut($($fw_arg_type),*) -> $fw_ret> = $tr_userdata_name.cast();
			let out = unsafe { (*callback)($($fw_arg_name),*) };
			out
		}

		let $tr_name = if $callback_name.is_some() {
			Some(trampoline as unsafe extern "C" fn($($tr_arg_type),*) -> $tr_ret)
		} else {
			None
		};
	}
}

macro_rules! userdata_arg {
	($userdata_name: ident: $userdata_type: ty => $callback_name: ident) => {
		let $userdata_name: $userdata_type = if let Some(callback) = $callback_name {
			Box::into_raw(Box::new(callback)).cast()
		} else {
			::std::ptr::null_mut() // fixme, remove previous callback
		};
	};
}

macro_rules! input_array_arg {
	($name: ident) => {
		let $name = $name.input_array()?;
	};
}

macro_rules! output_array_arg {
	($name: ident) => {
		let $name = $name.output_array()?;
	};
}

macro_rules! input_output_array_arg {
	($name: ident) => {
		let $name = $name.input_output_array()?;
	};
}

macro_rules! string_array_arg {
	($name: ident) => {
		let $name = $name
			.iter()
			.map(|x| ::std::ffi::CString::new(*x).expect("invalid C string"))
			.collect::<::std::vec::Vec<_>>();
		let $name = $name.iter().map(|x| x.as_ptr()).collect::<::std::vec::Vec<_>>();
	};
}

#[allow(unused_macros)]
macro_rules! string_array_arg_mut {
	($name: ident) => {
		let $name = $name
			.iter()
			.map(|x| ::std::ffi::CString::new(*x).expect("invalid C string"))
			.collect::<::std::vec::Vec<_>>();
		// fixme: Casting to mut below trusts on undefined CString behavior.
		let mut $name = $name.iter().map(|x| x.as_ptr().cast_mut()).collect::<::std::vec::Vec<_>>();
	};
}

macro_rules! smart_ptr_option_arg {
	(ref $name: ident) => {
		let null = if $name.is_none() {
			Some(unsafe { $crate::core::Ptr::new_null() })
		} else {
			None
		};
		let $name = $name.or(null.as_ref()).expect("Nullability should have been checked");
	};
	($name: ident) => {
		let $name = $name.unwrap_or_else(|| unsafe { $crate::core::Ptr::new_null() });
	};
}

macro_rules! return_send {
	(via $name: ident) => {
		let mut $name = ::std::mem::MaybeUninit::uninit();
	};
}

macro_rules! return_receive {
	($name_via: ident => $name: ident) => {
		let $name = unsafe { $name_via.assume_init() };
	};
}

/// The return type of this function goes into `receive_string::<String>()`
#[inline(always)]
pub unsafe fn ocvrs_create_string(s: *const c_char) -> *mut String {
	let s = unsafe { CStr::from_ptr(s) }.to_string_lossy().into_owned();
	Box::into_raw(Box::new(s))
}

/// The return type of this function goes into `receive_string::<Vec<u8>>()`
#[inline(always)]
pub unsafe fn ocvrs_create_byte_string(v: *const u8, len: size_t) -> *mut Vec<u8> {
	let byte_slice = if v.is_null() {
		&[]
	} else {
		unsafe { slice::from_raw_parts(v, len) }
	};
	let v = byte_slice.to_vec();
	Box::into_raw(Box::new(v))
}

/// Used for both regular `String` and byte string (`Vec<u8>`)
#[inline]
pub unsafe fn receive_string<T>(s: *mut T) -> T {
	if s.is_null() {
		panic!("Got null pointer for receive_string()");
	}
	unsafe { *Box::from_raw(s) }
}