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

/*
 * File: silencer.rs
 * Project: datagram
 * Created Date: 01/09/2023
 * Author: Shun Suzuki
 * -----
 * Last Modified: 21/11/2023
 * Modified By: Shun Suzuki (suzuki@hapis.k.u-tokyo.ac.jp)
 * -----
 * Copyright (c) 2023 Shun Suzuki. All rights reserved.
 *
 */

use std::time::Duration;

use crate::{
    datagram::*,
    error::AUTDInternalError,
    fpga::{SILENCER_STEP_DEFAULT, SILENCER_STEP_MAX, SILENCER_STEP_MIN},
};

/// Datagram for configure silencer
#[derive(Debug, Clone, Copy)]
pub struct Silencer {
    step_intensity: u16,
    step_phase: u16,
}

impl Silencer {
    /// constructor
    ///
    /// # Arguments
    /// * `step` - The update step of silencer. The lower the value, the stronger the silencer effect.
    pub fn new(step_intensity: u16, step_phase: u16) -> Result<Self, AUTDInternalError> {
        if !(SILENCER_STEP_MIN..=SILENCER_STEP_MAX).contains(&step_intensity) {
            return Err(AUTDInternalError::SilencerStepOutOfRange(step_intensity));
        }
        if !(SILENCER_STEP_MIN..=SILENCER_STEP_MAX).contains(&step_phase) {
            return Err(AUTDInternalError::SilencerStepOutOfRange(step_phase));
        }
        Ok(Self {
            step_intensity,
            step_phase,
        })
    }

    /// Disable silencer
    pub const fn disable() -> Self {
        Self {
            step_intensity: SILENCER_STEP_MAX,
            step_phase: SILENCER_STEP_MAX,
        }
    }

    pub const fn step_intensity(&self) -> u16 {
        self.step_intensity
    }

    pub const fn step_phase(&self) -> u16 {
        self.step_phase
    }
}

impl Default for Silencer {
    fn default() -> Self {
        Self {
            step_intensity: SILENCER_STEP_DEFAULT,
            step_phase: SILENCER_STEP_DEFAULT,
        }
    }
}

impl Datagram for Silencer {
    type O1 = crate::operation::ConfigSilencerOp;
    type O2 = crate::operation::NullOp;

    fn timeout(&self) -> Option<Duration> {
        Some(Duration::from_millis(200))
    }

    fn operation(self) -> Result<(Self::O1, Self::O2), AUTDInternalError> {
        Ok((
            Self::O1::new(self.step_intensity, self.step_phase),
            Self::O2::default(),
        ))
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_silencer() {
        let silencer = Silencer::new(10, 20).unwrap();
        assert_eq!(silencer.step_intensity(), 10);
        assert_eq!(silencer.step_phase(), 20);
        assert_eq!(silencer.step_intensity(), silencer.clone().step_intensity());
        assert_eq!(silencer.step_phase(), silencer.clone().step_phase());

        let silencer = Silencer::new(0, 1);
        assert_eq!(
            silencer.unwrap_err(),
            AUTDInternalError::SilencerStepOutOfRange(0)
        );

        let silencer = Silencer::new(1, 0);
        assert_eq!(
            silencer.unwrap_err(),
            AUTDInternalError::SilencerStepOutOfRange(0)
        );
    }

    #[test]
    fn test_silencer_debug() {
        let silencer = Silencer::new(10, 20).unwrap();
        assert_eq!(
            format!("{:?}", silencer),
            "Silencer { step_intensity: 10, step_phase: 20 }"
        );
    }

    #[test]
    fn test_silencer_disable() {
        let silencer = Silencer::disable();
        assert_eq!(silencer.step_intensity(), SILENCER_STEP_MAX);
        assert_eq!(silencer.step_phase(), SILENCER_STEP_MAX);
    }

    #[test]
    fn test_silencer_default() {
        let silencer = Silencer::default();
        assert_eq!(silencer.step_intensity(), SILENCER_STEP_DEFAULT);
        assert_eq!(silencer.step_phase(), SILENCER_STEP_DEFAULT);
    }

    #[test]
    fn test_silencer_timeout() {
        let silencer = Silencer::new(1, 2).unwrap();
        let timeout = <Silencer as Datagram>::timeout(&silencer);
        assert!(timeout.is_some());
        assert!(timeout.unwrap() > Duration::ZERO);
    }

    #[test]
    fn test_silencer_operation() {
        let silencer = Silencer::new(1, 2).unwrap();
        let r = <Silencer as Datagram>::operation(silencer);
        assert!(r.is_ok());
        let _: (crate::operation::ConfigSilencerOp, crate::operation::NullOp) = r.unwrap();
    }
}