autd3-rs 0.4.0

Core async client library for the AUTD3 phased-array kit.
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

#[cfg(windows)]
mod imp {
    use windows_sys::Win32::Media::{timeBeginPeriod, timeEndPeriod};
    use windows_sys::Win32::System::Threading::{
        GetCurrentProcess, HIGH_PRIORITY_CLASS, SetPriorityClass,
    };

    const TIMER_PERIOD_MS: u32 = 1;
    const TIMERR_NOERROR: u32 = 0;

    pub struct PerfTuning {
        timer_set: bool,
        priority_set: bool,
    }

    impl PerfTuning {
        #[must_use]
        pub fn apply() -> Self {
            // SAFETY: timeBeginPeriod is a thread-safe winmm call; it is paired
            // with timeEndPeriod(TIMER_PERIOD_MS) in Drop.
            let timer_set = unsafe { timeBeginPeriod(TIMER_PERIOD_MS) } == TIMERR_NOERROR;
            // SAFETY: GetCurrentProcess returns a pseudo-handle that needs no
            // close; SetPriorityClass only reads it.
            let priority_set =
                unsafe { SetPriorityClass(GetCurrentProcess(), HIGH_PRIORITY_CLASS) != 0 };
            Self {
                timer_set,
                priority_set,
            }
        }

        #[must_use]
        pub fn timer_boosted(&self) -> bool {
            self.timer_set
        }

        #[must_use]
        pub fn high_priority(&self) -> bool {
            self.priority_set
        }
    }

    impl Drop for PerfTuning {
        fn drop(&mut self) {
            if self.timer_set {
                // SAFETY: matches the earlier timeBeginPeriod(TIMER_PERIOD_MS).
                unsafe {
                    timeEndPeriod(TIMER_PERIOD_MS);
                }
            }
        }
    }
}

#[cfg(not(windows))]
mod imp {
    pub struct PerfTuning;

    impl PerfTuning {
        #[must_use]
        pub fn apply() -> Self {
            Self
        }

        #[must_use]
        pub fn timer_boosted(&self) -> bool {
            false
        }

        #[must_use]
        pub fn high_priority(&self) -> bool {
            false
        }
    }
}

pub use imp::PerfTuning;