cidre 0.11.2

Apple frameworks bindings for rust
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

use crate::{arc, cm, define_cls, define_obj_type, ns, objc, vn};

define_obj_type!(
    #[doc(alias = "VNStatefulRequest")]
    pub StatefulRequest(vn::ImageBasedRequest)
);

impl arc::A<StatefulRequest> {
    #[objc::msg_send(initWithFrameAnalysisSpacing:completionHandler:)]
    pub fn init_with_frame_analysis_spacing_ch(
        self,
        frame_analysis_spacing: cm::Time,
        ch: Option<&mut vn::RequestCh>,
    ) -> arc::R<StatefulRequest>;
}

impl StatefulRequest {
    define_cls!(VN_STATEFUL_REQUEST);

    pub fn with_frame_analysis_spacing_ch(
        frame_analysis_spacing: cm::Time,
        ch: Option<&mut vn::RequestCh>,
    ) -> arc::R<Self> {
        Self::alloc().init_with_frame_analysis_spacing_ch(frame_analysis_spacing, ch)
    }

    pub fn with_frame_analysis_spacing(
        frame_analysis_spacing: cm::Time,
        completion: impl FnMut(&mut vn::Request, Option<&ns::Error>) + 'static,
    ) -> arc::R<Self> {
        let mut block = vn::RequestCh::new2(completion);
        Self::with_frame_analysis_spacing_ch(frame_analysis_spacing, Some(&mut block))
    }

    /// The minimum number of frames that the request has to process on before reporting back any observation.
    /// This information is provided by the request once initialized with its required paramters.
    ///
    /// Video based request often need a minimum number of frames before they can report back any observation.
    /// An example would be that a movement detection requires at least 5 frames to be detected. The minimum_latency_frame_count for that
    /// request would report 5 and only after 5 frames have been processed an observation would be returned in the results.
    /// This latency is indicative of how responsive a request is in respect to the incoming data.
    #[objc::msg_send(minimumLatencyFrameCount)]
    pub fn minimum_latency_frame_count(&self) -> isize;

    /// The reciprocal of maximum rate at which buffers will be processed.
    ///
    /// The request will not process buffers that fall within the `frame_analysis_spacing` after it has performed the analysis.
    /// The analysis is not done by wall time but by analysis of of the time stamps of the samplebuffers being processed.
    #[objc::msg_send(frameAnalysisSpacing)]
    pub fn frame_analysis_spacing(&self) -> cm::Time;
}

#[link(name = "vn", kind = "static")]
unsafe extern "C" {
    static VN_STATEFUL_REQUEST: &'static objc::Class<StatefulRequest>;
}

#[cfg(test)]
mod tests {
    use crate::{cm, vn};
    #[test]
    pub fn basics() {
        let request = vn::StatefulRequest::with_frame_analysis_spacing_ch(cm::Time::zero(), None);
        assert_eq!(request.frame_analysis_spacing(), cm::Time::zero());

        let request =
            vn::StatefulRequest::with_frame_analysis_spacing(cm::Time::zero(), |request, error| {
                if let Some(err) = error {
                    println!("err {err:?}");
                    return;
                }
                let _r = request.results();
            });
        assert_eq!(request.frame_analysis_spacing(), cm::Time::zero());
    }
}