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

@@ -43,69 +43,24 @@ impl<'tu, 'ge> ClassDesc<'tu, 'ge> {
 		}
 	}
 
-	/// `cv::Scalar`
-	pub fn cv_scalar() -> Class<'tu, 'ge> {
-		Class::new_desc(Self::simple("cv::Scalar", "core"))
+	/// `cv::Scalar_`
+	pub fn cv_scalar_() -> Class<'tu, 'ge> {
+		Class::new_desc(Self::simple("cv::Scalar_", "core"))
 	}
 
-	/// `cv::Size`
-	pub fn cv_size() -> Class<'tu, 'ge> {
-		Class::new_desc(Self::simple("cv::Size", "core"))
+	/// `cv::Size_`
+	pub fn cv_size_() -> Class<'tu, 'ge> {
+		Class::new_desc(Self::simple("cv::Size_", "core"))
 	}
 
-	/// `cv::Point`
-	pub fn cv_point() -> Class<'tu, 'ge> {
-		Class::new_desc(Self::simple("cv::Point", "core"))
+	/// `cv::Point_`
+	pub fn cv_point_() -> Class<'tu, 'ge> {
+		Class::new_desc(Self::simple("cv::Point_", "core"))
 	}
 
-	/// `cv::Point2f`
-	pub fn cv_point2f() -> Class<'tu, 'ge> {
-		Class::new_desc(Self::simple("cv::Point2f", "core"))
-	}
-
-	/// `cv::Point2d`
-	pub fn cv_point2d() -> Class<'tu, 'ge> {
-		Class::new_desc(Self::simple("cv::Point2d", "core"))
-	}
-
-	/// `cv::Point3i`
-	pub fn cv_point3i() -> Class<'tu, 'ge> {
-		Class::new_desc(Self::simple("cv::Point3i", "core"))
-	}
-
-	/// `cv::Point3f`
-	pub fn cv_point3f() -> Class<'tu, 'ge> {
-		Class::new_desc(Self::simple("cv::Point3f", "core"))
-	}
-
-	/// `cv::Point3d`
-	pub fn cv_point3d() -> Class<'tu, 'ge> {
-		Class::new_desc(Self::simple("cv::Point3d", "core"))
-	}
-
-	/// `cv::Vec2f`
-	pub fn cv_vec2f() -> Class<'tu, 'ge> {
-		Class::new_desc(Self::simple("cv::Vec2f", "core"))
-	}
-
-	/// `cv::Vec2d`
-	pub fn cv_vec2d() -> Class<'tu, 'ge> {
-		Class::new_desc(Self::simple("cv::Vec2d", "core"))
-	}
-
-	/// `cv::Vec3f`
-	pub fn cv_vec3f() -> Class<'tu, 'ge> {
-		Class::new_desc(Self::simple("cv::Vec3f", "core"))
-	}
-
-	/// `cv::Vec3d`
-	pub fn cv_vec3d() -> Class<'tu, 'ge> {
-		Class::new_desc(Self::simple("cv::Vec3d", "core"))
-	}
-
-	/// `cv::Vec4i`
-	pub fn cv_vec4i() -> Class<'tu, 'ge> {
-		Class::new_desc(Self::simple("cv::Vec4i", "core"))
+	/// `cv::Vec`
+	pub fn cv_vec() -> Class<'tu, 'ge> {
+		Class::new_desc(Self::simple("cv::Vec", "core"))
 	}
 
 	/// `cv::String`
@@ -156,4 +111,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/func.rs

@@ -191,6 +191,7 @@ impl<'tu, 'ge> Func<'tu, 'ge> {
 					cpp_body: FuncCppBody::Auto,
 					rust_body: FuncRustBody::Auto,
 					rust_extern_definition: FuncRustExtern::Auto,
+					cfg_attr: Rc::new(None),
 				})
 			}
 			Func::Desc(desc) => {
@@ -631,7 +632,11 @@ impl<'tu, 'ge> Func<'tu, 'ge> {
 	pub fn cfg_attrs(&self) -> Option<(&str, &str)> {
 		match self {
 			Self::Clang { gen_env, .. } => gen_env.settings.func_cfg_attr.get(&mut self.matcher()).copied(),
-			Self::Desc(_) => None,
+			Self::Desc(desc) => desc
+				.cfg_attr
+				.as_ref()
+				.as_ref()
+				.map(|(rust, cpp)| (rust.as_str(), cpp.as_str())),
 		}
 	}
 }

binding-generator/src/func/desc.rs

@@ -26,6 +26,7 @@ pub struct FuncDesc<'tu, 'ge> {
 	pub cpp_body: FuncCppBody,
 	pub rust_body: FuncRustBody,
 	pub rust_extern_definition: FuncRustExtern,
+	pub cfg_attr: Rc<Option<(String, String)>>,
 }
 
 impl<'tu, 'ge> FuncDesc<'tu, 'ge> {
@@ -54,6 +55,7 @@ impl<'tu, 'ge> FuncDesc<'tu, 'ge> {
 			cpp_body: FuncCppBody::Auto,
 			rust_body: FuncRustBody::Auto,
 			rust_extern_definition: FuncRustExtern::Auto,
+			cfg_attr: Rc::new(None),
 		}
 	}
 
@@ -105,6 +107,12 @@ impl<'tu, 'ge> FuncDesc<'tu, 'ge> {
 		self
 	}
 
+	#[inline]
+	pub fn cfg_attr(mut self, cfg_attr: Option<(String, String)>) -> Self {
+		self.cfg_attr = cfg_attr.into();
+		self
+	}
+
 	pub fn method_delete(class_desc: Class<'tu, 'ge>) -> Func<'tu, 'ge> {
 		Func::new_desc(
 			FuncDesc::new(

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);
@@ -309,17 +314,16 @@ impl<'tu, 'r, V: GeneratorVisitor<'tu>> OpenCvWalker<'tu, 'r, V> {
 		if typedef.exclude_kind().is_included() {
 			match typedef {
 				NewTypedefResult::Typedef(typedef) => {
-					let type_ref = typedef.type_ref();
-					let export = gen_env.get_export_config(typedef_decl).is_some()
-						// we need to have a typedef even if it's not exported for e.g. cv::Size
-						|| type_ref.is_data_type()
-						|| {
+					let export = gen_env.get_export_config(typedef_decl).is_some() || {
 						let underlying_type = typedef.underlying_type_ref();
 						underlying_type.kind().is_function()
 							|| !underlying_type.exclude_kind().is_ignored()
-							|| underlying_type.template_kind().as_template_specialization().map_or(false, |templ| {
-							settings::IMPLEMENTED_GENERICS.contains(templ.cpp_name(CppNameStyle::Reference).as_ref())
-						})
+							|| underlying_type
+								.template_kind()
+								.as_template_specialization()
+								.map_or(false, |templ| {
+									settings::IMPLEMENTED_GENERICS.contains(templ.cpp_name(CppNameStyle::Reference).as_ref())
+								})
 					};
 
 					if export {
@@ -455,8 +459,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);