Support OpenCV 5, drop support for 3.2

Author: twistedfall

.github/workflows/opencv-rust.yml

@@ -22,6 +22,9 @@ jobs:
           - os-image: ubuntu-22.04
             opencv-version: 4.11.0
             linkage: static
+          - os-image: ubuntu-22.04
+            opencv-version: 5.0.0-alpha
+            linkage: dynamic
           - os-image: ubuntu-22.04
             opencv-version: 3.4.20
             linkage: dynamic

Cargo.toml

@@ -22,6 +22,7 @@ maintenance = { status = "actively-developed" }
 members = ["binding-generator"]
 
 [dependencies]
+half = { version = "2", optional = true }
 libc = "0.2"
 num-traits = "0.2"
 once_cell = "1"
@@ -61,29 +62,35 @@ vcpkg = "0.2.9"
 
 [features]
 default = [
+	"3d",
 	"alphamat",
 	"aruco",
 	"aruco_detector",
 	"barcode",
 	"bgsegm",
 	"bioinspired",
+	"calib",
 	"calib3d",
+	#"cannops",
 	"ccalib",
 	"cudaarithm",
 	"cudabgsegm",
 	"cudacodec",
 	"cudafeatures2d",
 	"cudafilters",
 	"cudaimgproc",
+	"cudalegacy",
 	"cudaobjdetect",
 	"cudaoptflow",
 	"cudastereo",
 	"cudawarping",
+	#"cudev",
 	"cvv",
 	"dnn",
 	"dnn_superres",
 	"dpm",
 	"face",
+	"features",
 	"features2d",
 	"flann",
 	"freetype",
@@ -128,32 +135,39 @@ default = [
 	"ximgproc",
 	"xobjdetect",
 	"xphoto",
+	"xstereo",
 ]
 
 # OpenCV module features
+3d = []
 alphamat = []
 aruco = []
 aruco_detector = ["aruco"]
 barcode = []
 bgsegm = ["video"]
 bioinspired = []
+calib = ["features"]
 calib3d = ["features2d"]
+#cannops = []
 ccalib = ["features2d"]
 cudaarithm = []
 cudabgsegm = ["video"]
 cudacodec = []
 cudafeatures2d = ["features2d"]
 cudafilters = []
 cudaimgproc = ["imgproc"]
+cudalegacy = []
 cudaobjdetect = ["objdetect"]
 cudaoptflow = []
 cudastereo = ["calib3d"]
 cudawarping = []
+#cudev = []
 cvv = []
 dnn = []
 dnn_superres = []
 dpm = []
 face = ["objdetect"]
+features = ["flann"]
 features2d = ["flann"]
 flann = []
 freetype = []
@@ -193,14 +207,16 @@ video = []
 videoio = []
 videostab = ["features2d"]
 viz = []
+wechat_qrcode = []
 xfeatures2d = ["features2d"]
 ximgproc = ["calib3d"]
 xobjdetect = []
 xphoto = ["photo"]
-wechat_qrcode = []
+xstereo = []
 
 # General features
 clang-runtime = ["opencv-binding-generator/clang-runtime"]
+f16 = ["dep:half"]
 
 [package.metadata.docs.rs]
 no-default-features = true

README.md

@@ -14,7 +14,7 @@ The API is usable, but unstable and not very battle-tested; use at your own risk
 
 ## Quickstart
 
-Make sure the supported OpenCV version (3.4 or 4.x) and Clang (part of LLVM, needed for automatic binding
+Make sure the supported OpenCV version (3.4, 4.x or 5.x) and Clang (part of LLVM, needed for automatic binding
 generation) are installed in your system.
 
 Update your Cargo.toml
@@ -145,6 +145,7 @@ The following variables affect the building the of the `opencv` crate, but belon
 * `clang-runtime` - enables the runtime detection of libclang (`runtime` feature of `clang-sys`). Useful as a
   workaround for when your dependencies (like `bindgen`) pull in `clang-sys` with hard `runtime` feature.
 * `rgb` - allow using [`rgb`](https://crates.io/crates/rgb) crate types as `Mat` elements
+* `f16` - add intergration with `f16` type from the `half` crate
 
 ## API details
 
@@ -158,6 +159,7 @@ The following OpenCV versions are supported at the moment:
 
 * 3.4
 * 4.x
+* 5.x (preliminary)
 
 ### Minimum rustc version (MSRV)
 
@@ -279,7 +281,7 @@ version because the crate has gone through the considerable rewrite since.
 ### OpenCV 3.2
 
 The last version with confirmed OpenCV 3.2 support is 0.75.0, after that this branch of OpenCV is no longer
-tested and supported. It may still work though.
+tested and supported. Since version 0.94.0 the support of OpenCV 3.2 is removed from the codebase.
 
 ## Contributor's Guide
 

binding-generator/src/bin/binding-generator.rs

@@ -82,5 +82,5 @@ fn main() {
 		.map(Path::new)
 		.collect::<Vec<_>>();
 	let bindings_writer = RustNativeBindingWriter::new(&src_cpp_dir, &out_dir, module, &version, debug);
-	Generator::new(&opencv_header_dir, &additional_include_dirs, &src_cpp_dir).generate(module, bindings_writer);
+	Generator::new(&opencv_header_dir, &additional_include_dirs, &src_cpp_dir).generate(module, !debug, bindings_writer);
 }

binding-generator/src/class/desc.rs

@@ -156,4 +156,9 @@ impl<'tu, 'ge> ClassDesc<'tu, 'ge> {
 	pub fn cv_dnn_dict_value() -> Class<'tu, 'ge> {
 		Class::new_desc(Self::boxed("cv::dnn::DictValue", "dnn"))
 	}
+
+	/// `cv::Feature2D`
+	pub fn cv_keypoint() -> Class<'tu, 'ge> {
+		Class::new_desc(Self::boxed("cv::KeyPoint", "core"))
+	}
 }

binding-generator/src/constant.rs

@@ -44,14 +44,21 @@ pub fn render_constant_rust(tokens: &[Token]) -> Option<Value> {
 				let spelling = t.get_spelling();
 				if spelling.contains(['"', '\'']) {
 					out.kind = ValueKind::String;
+					out.value += &spelling;
 				} else if spelling.contains('.') {
-					out.kind = ValueKind::Float;
+					if let Some(float) = spelling.strip_suffix(['F', 'f']) {
+						out.kind = ValueKind::Float;
+						out.value += float;
+					} else {
+						out.kind = ValueKind::Double;
+						out.value += &spelling;
+					}
 				} else if let Some(unsigned_value) = spelling.strip_suffix(['U', 'u']) {
 					out.kind = ValueKind::UnsignedInteger;
 					out.value += unsigned_value;
-					continue;
+				} else {
+					out.value += &spelling;
 				}
-				out.value += &spelling;
 			}
 			TokenKind::Punctuation => {
 				let spelling = t.get_spelling();
@@ -85,7 +92,7 @@ pub fn render_evaluation_result_rust(result: EvaluationResult) -> Value {
 			value: x.to_string(),
 		},
 		EvaluationResult::Float(x) => Value {
-			kind: ValueKind::Float,
+			kind: ValueKind::Double,
 			value: x.to_string(),
 		},
 		EvaluationResult::String(x)
@@ -181,6 +188,7 @@ pub enum ValueKind {
 	Integer,
 	UnsignedInteger,
 	Float,
+	Double,
 	String,
 }
 
@@ -192,7 +200,7 @@ pub struct Value {
 
 impl fmt::Display for Value {
 	fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
-		if self.kind == ValueKind::Float && !self.value.contains('.') {
+		if self.kind == ValueKind::Double && !self.value.contains('.') {
 			write!(f, "{}.", self.value)
 		} else {
 			write!(f, "{}", self.value)

binding-generator/src/generator.rs

@@ -104,7 +104,12 @@ impl<'tu, V: GeneratorVisitor<'tu>> EntityWalkerVisitor<'tu> for OpenCvWalker<'t
 						"GAPI_EXPORTS_W",
 						"GAPI_WRAP",
 					];
-					const SIMPLE: [&str; 3] = ["CV_EXPORTS_W_SIMPLE", "CV_EXPORTS_W_MAP", "GAPI_EXPORTS_W_SIMPLE"];
+					const SIMPLE: [&str; 4] = [
+						"CV_EXPORTS_W_SIMPLE",
+						"CV_EXPORTS_W_PARAMS",
+						"CV_EXPORTS_W_MAP",
+						"GAPI_EXPORTS_W_SIMPLE",
+					];
 					const RENAME: [&str; 2] = ["CV_EXPORTS_AS", "CV_WRAP_AS"];
 					if BOXED.contains(&name.as_str()) {
 						self.gen_env.make_export_config(entity);
@@ -455,8 +460,8 @@ impl Generator {
 	}
 
 	/// Runs the full binding generation process using the supplied `visitor`
-	pub fn generate(&self, module: &str, visitor: impl for<'tu> GeneratorVisitor<'tu>) {
-		self.pre_process(module, true, |root_entity| {
+	pub fn generate(&self, module: &str, panic_on_error: bool, visitor: impl for<'tu> GeneratorVisitor<'tu>) {
+		self.pre_process(module, panic_on_error, |root_entity| {
 			let gen_env = GeneratorEnv::global(module, root_entity);
 			let opencv_walker = OpenCvWalker::new(module, &self.opencv_module_header_dir, visitor, gen_env);
 			root_entity.walk_opencv_entities(opencv_walker);

binding-generator/src/settings.rs

@@ -187,6 +187,7 @@ pub static RESERVED_RENAME: Lazy<HashMap<&str, &str>> = Lazy::new(|| {
 		("impl", "impl_"),
 		("loop", "loop_"),
 		("yield", "yield_"),
+		("where", "where_"),
 	])
 });
 
@@ -275,6 +276,7 @@ pub static NO_SKIP_NAMESPACE_IN_LOCALNAME: Lazy<HashMap<&str, HashMap<&str, &str
 		("cudacodec", HashMap::from([("cudacodec", "CUDA")])),
 		("cudafeatures2d", HashMap::from([("cuda", "CUDA")])),
 		("cudaimgproc", HashMap::from([("cuda", "CUDA")])),
+		("cudalegacy", HashMap::from([("cuda", "CUDA")])),
 		("cudaobjdetect", HashMap::from([("cuda", "CUDA")])),
 		("cudaoptflow", HashMap::from([("cuda", "CUDA")])),
 		("cudastereo", HashMap::from([("cuda", "CUDA")])),
@@ -297,7 +299,9 @@ pub static NO_SKIP_NAMESPACE_IN_LOCALNAME: Lazy<HashMap<&str, HashMap<&str, &str
 
 pub static PREVENT_VECTOR_TYPEDEF_GENERATION: Lazy<HashSet<&str>> = Lazy::new(|| {
 	HashSet::from([
-		// `MatShape` is an alias to `Vector<i32>` and this leads to duplication of definition for that type
+		// `MatShape` is an alias to `Vector<i32>` and this leads to duplication of definition for the `Vector<Vector<i32>>` type
 		"cv::dnn::MatShape",
+		// `MatType` is an alias `i32` and we don't want to duplicate `Vector<i32>` with `Vector<MatType>`
+		"cv::dnn::MatType",
 	])
 });

binding-generator/src/settings/argument_override.rs

@@ -13,7 +13,7 @@ pub type PropertyOverride = HashMap<&'static str, TypeRefTypeHint>;
 
 pub fn arg_override_factory(module: &str) -> ArgOverride {
 	match module {
-		"calib3d" => calib3d_arg_override_factory(),
+		"calib3d" | "calib" | "3d" => calib3d_arg_override_factory(),
 		"core" => core_arg_override_factory(),
 		"freetype" => freetype_arg_override_factory(),
 		"highgui" => highgui_arg_override_factory(),

binding-generator/src/settings/element_exclude_kind.rs

@@ -7,16 +7,13 @@ use crate::element::ExcludeKind;
 /// cpp_name(Reference)
 pub static ELEMENT_EXCLUDE_KIND: Lazy<HashMap<&str, ExcludeKind>> = Lazy::new(|| {
 	HashMap::from([
-		("cv::internal::format", ExcludeKind::Excluded),        // 3.2 duplicate definition
 		("cv::face::FacemarkLBF::BBox", ExcludeKind::Excluded), // not used, not exported in windows dll
 		("CV_DEPRECATED", ExcludeKind::Ignored),
 		("CV_EXPORTS", ExcludeKind::Ignored),
-		("CV_IMPL", ExcludeKind::Ignored), // 3.2
+		("CV_IMPL", ExcludeKind::Ignored),
 		("CV_MAKE_TYPE", ExcludeKind::Ignored),
-		("CvFileNode", ExcludeKind::Ignored), // 3.2 3.4 C struct
-		("CvSeq", ExcludeKind::Ignored),      // 3.2 C struct
 		("FILE", ExcludeKind::Ignored),
-		("HG_AUTOSIZE", ExcludeKind::Ignored), // 3.2
+		("HG_AUTOSIZE", ExcludeKind::Ignored), // 3.4
 		("cv::ErrorCallback", ExcludeKind::Ignored),
 		("cv::MatAllocator", ExcludeKind::Ignored),         // doesn't handle cpp part too well
 		("cv::MatExpr::op", ExcludeKind::Ignored),          // fixme implement PointerOf types