autd-timer 2.0.0

Native timer wrapper.
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

/*
 * File: native_timer_wrapper.rs
 * Project: src
 * Created Date: 12/12/2019
 * Author: Shun Suzuki
 * -----
 * Last Modified: 31/12/2020
 * Modified By: Shun Suzuki (suzuki@hapis.k.u-tokyo.ac.jp)
 * -----
 * Copyright (c) 2019 Hapis Lab. All rights reserved.
 *
 */

use winapi::shared::basetsd::DWORD_PTR;
use winapi::um::mmsystem::MMRESULT;
use winapi::um::threadpoollegacyapiset;
use winapi::um::timeapi::{timeBeginPeriod, timeEndPeriod};

type LPTIMECALLBACK = Option<
    unsafe extern "system" fn(
        u_timer_id: u32,
        u_msg: u32,
        dw_user: DWORD_PTR,
        dw1: DWORD_PTR,
        dw2: DWORD_PTR,
    ),
>;

const TIME_PERIODIC: u32 = 1;

#[link(name = "winmm")]
extern "C" {
    pub fn timeSetEvent(
        u_delay: u32,
        u_resolution: u32,
        lp_time_proc: LPTIMECALLBACK,
        dw_user: DWORD_PTR,
        fu_event: u32,
    ) -> MMRESULT;
    pub fn timeKillEvent(u_timer_id: u32) -> MMRESULT;
}

pub struct NativeTimerWrapper {
    timer_id: Option<u32>,
}

impl NativeTimerWrapper {
    pub fn new() -> NativeTimerWrapper {
        NativeTimerWrapper { timer_id: None }
    }

    pub fn start<P>(&mut self, cb: LPTIMECALLBACK, period_ns: u32, lp_param: *mut P) -> u32 {
        unsafe {
            let timer_queue = threadpoollegacyapiset::CreateTimerQueue();
            if timer_queue.is_null() {
                return 0;
            }

            let u_resolution = 1;
            timeBeginPeriod(u_resolution);
            let timer_id = timeSetEvent(
                period_ns / 1000 / 1000,
                u_resolution,
                cb,
                lp_param as usize,
                TIME_PERIODIC,
            );
            if timer_id != 0 {
                self.timer_id = Some(timer_id);
            }
            timer_id
        }
    }

    pub fn close(&mut self) -> i32 {
        if let Some(timer_id) = self.timer_id.take() {
            unsafe {
                timeEndPeriod(1);
                timeKillEvent(timer_id);
                0
            }
        } else {
            1
        }
    }
}

impl Drop for NativeTimerWrapper {
    fn drop(&mut self) {
        let _ = self.close();
    }
}