apple-vision 0.13.0

Safe Rust bindings for Apple's Vision framework — OCR, object detection, face landmarks on macOS
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

//! Rectangle + document-segmentation detection.
//!
//! `VNDetectRectanglesRequest` finds quadrilaterals (signs, photos,
//! book pages); `VNDetectDocumentSegmentationRequest` finds full
//! document boundaries — both return the same observation shape.

use core::ffi::c_char;
use core::ptr;
use std::ffi::CString;
use std::path::Path;

use crate::error::{from_swift, VisionError};
use crate::face_landmarks::LandmarkPoint;
use crate::ffi;
use crate::recognize_text::BoundingBox;

/// A detected quadrilateral with axis-aligned bounding box plus
/// individual corner points (in normalised image coordinates,
/// bottom-left origin).
#[derive(Debug, Clone, PartialEq)]
pub struct RectangleObservation {
    pub bounding_box: BoundingBox,
    pub confidence: f32,
    pub top_left: LandmarkPoint,
    pub top_right: LandmarkPoint,
    pub bottom_left: LandmarkPoint,
    pub bottom_right: LandmarkPoint,
}

/// Optional tuning for `detect_rectangles_in_path`. Pass `default()`
/// to use Apple's defaults.
#[derive(Debug, Clone, Copy, Default)]
pub struct RectangleOptions {
    /// `0` ⇒ Apple default.
    pub max_observations: usize,
    /// `0` ⇒ Apple default.
    pub minimum_aspect_ratio: f32,
    /// `0` ⇒ Apple default.
    pub maximum_aspect_ratio: f32,
    /// `0` ⇒ Apple default (normalised size of smallest rectangle).
    pub minimum_size: f32,
    /// `0` ⇒ Apple default.
    pub minimum_confidence: f32,
}

/// Detect rectangles in the image at `path`.
///
/// # Errors
///
/// Returns [`VisionError::ImageLoadFailed`] / [`VisionError::RequestFailed`].
pub fn detect_rectangles_in_path(
    path: impl AsRef<Path>,
    options: RectangleOptions,
) -> Result<Vec<RectangleObservation>, VisionError> {
    let path_str = path
        .as_ref()
        .to_str()
        .ok_or_else(|| VisionError::InvalidArgument("non-UTF-8 path".into()))?;
    let path_c = CString::new(path_str)
        .map_err(|e| VisionError::InvalidArgument(format!("path NUL byte: {e}")))?;

    let mut out_array: *mut core::ffi::c_void = ptr::null_mut();
    let mut out_count: usize = 0;
    let mut err_msg: *mut c_char = ptr::null_mut();

    let status = unsafe {
        ffi::vn_detect_rectangles_in_path(
            path_c.as_ptr(),
            options.max_observations,
            options.minimum_aspect_ratio,
            options.maximum_aspect_ratio,
            options.minimum_size,
            options.minimum_confidence,
            &mut out_array,
            &mut out_count,
            &mut err_msg,
        )
    };
    if status != ffi::status::OK {
        return Err(unsafe { from_swift(status, err_msg) });
    }
    Ok(unsafe { collect_rects(out_array, out_count) })
}

/// Detect a full document's boundary in the image at `path`. Returns
/// at most one rectangle (the document outline).
///
/// # Errors
///
/// Returns [`VisionError::ImageLoadFailed`] / [`VisionError::RequestFailed`].
pub fn detect_document_segmentation_in_path(
    path: impl AsRef<Path>,
) -> Result<Vec<RectangleObservation>, VisionError> {
    let path_str = path
        .as_ref()
        .to_str()
        .ok_or_else(|| VisionError::InvalidArgument("non-UTF-8 path".into()))?;
    let path_c = CString::new(path_str)
        .map_err(|e| VisionError::InvalidArgument(format!("path NUL byte: {e}")))?;

    let mut out_array: *mut core::ffi::c_void = ptr::null_mut();
    let mut out_count: usize = 0;
    let mut err_msg: *mut c_char = ptr::null_mut();

    let status = unsafe {
        ffi::vn_detect_document_segmentation_in_path(
            path_c.as_ptr(),
            &mut out_array,
            &mut out_count,
            &mut err_msg,
        )
    };
    if status != ffi::status::OK {
        return Err(unsafe { from_swift(status, err_msg) });
    }
    Ok(unsafe { collect_rects(out_array, out_count) })
}

unsafe fn collect_rects(
    out_array: *mut core::ffi::c_void,
    out_count: usize,
) -> Vec<RectangleObservation> {
    if out_array.is_null() || out_count == 0 {
        return Vec::new();
    }
    let typed = out_array.cast::<ffi::RectangleObservationRaw>();
    let mut v = Vec::with_capacity(out_count);
    for i in 0..out_count {
        let r = unsafe { &*typed.add(i) };
        v.push(RectangleObservation {
            bounding_box: BoundingBox {
                x: r.bbox_x,
                y: r.bbox_y,
                width: r.bbox_w,
                height: r.bbox_h,
            },
            confidence: r.confidence,
            top_left: LandmarkPoint {
                x: r.tl_x,
                y: r.tl_y,
            },
            top_right: LandmarkPoint {
                x: r.tr_x,
                y: r.tr_y,
            },
            bottom_left: LandmarkPoint {
                x: r.bl_x,
                y: r.bl_y,
            },
            bottom_right: LandmarkPoint {
                x: r.br_x,
                y: r.br_y,
            },
        });
    }
    unsafe { ffi::vn_rectangle_observations_free(out_array, out_count) };
    v
}