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
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
mod cache;
mod radiation_pressure;
mod transform;

use std::sync::Arc;
use std::time::Duration;

pub use cache::Cache as ModulationCache;
pub use cache::IntoCache as IntoModulationCache;
pub use radiation_pressure::IntoRadiationPressure;
pub use radiation_pressure::RadiationPressure;
pub use transform::IntoTransform as IntoModulationTransform;
pub use transform::Transform as ModulationTransform;

use crate::defined::DEFAULT_TIMEOUT;
use crate::firmware::operation::OperationGenerator;
use crate::{
    error::AUTDInternalError,
    firmware::{
        fpga::{LoopBehavior, SamplingConfig, Segment, TransitionMode},
        operation::{ModulationOp, NullOp},
    },
    geometry::{Device, Geometry},
};

use itertools::Itertools;

use super::DatagramST;

pub type ModulationCalcResult = Result<Arc<Vec<u8>>, AUTDInternalError>;

pub trait ModulationProperty {
    fn sampling_config(&self) -> SamplingConfig;
    fn loop_behavior(&self) -> LoopBehavior;
}

#[allow(clippy::len_without_is_empty)]
pub trait Modulation: ModulationProperty {
    fn calc(&self) -> ModulationCalcResult;
    // GRCOV_EXCL_START
    #[tracing::instrument(skip(self, _geometry))]
    fn trace(&self, _geometry: &Geometry) {
        tracing::debug!("{}", tynm::type_name::<Self>());
    }
    // GRCOV_EXCL_STOP
}

// GRCOV_EXCL_START
impl<'a> ModulationProperty for Box<dyn Modulation + Send + Sync + 'a> {
    fn sampling_config(&self) -> SamplingConfig {
        self.as_ref().sampling_config()
    }

    fn loop_behavior(&self) -> LoopBehavior {
        self.as_ref().loop_behavior()
    }
}

impl<'a> Modulation for Box<dyn Modulation + Send + Sync + 'a> {
    fn calc(&self) -> ModulationCalcResult {
        self.as_ref().calc()
    }

    fn trace(&self, geometry: &Geometry) {
        self.as_ref().trace(geometry);
    }
}

pub struct ModulationOperationGenerator {
    #[allow(clippy::type_complexity)]
    pub g: Arc<Vec<u8>>,
    pub config: SamplingConfig,
    pub loop_behavior: LoopBehavior,
    pub segment: Segment,
    pub transition_mode: Option<TransitionMode>,
}

impl OperationGenerator for ModulationOperationGenerator {
    type O1 = ModulationOp;
    type O2 = NullOp;

    fn generate(&self, _: &Device) -> (Self::O1, Self::O2) {
        let d = self.g.clone();
        (
            ModulationOp::new(
                d,
                self.config,
                self.loop_behavior,
                self.segment,
                self.transition_mode,
            ),
            NullOp::default(),
        )
    }
}

impl<'a> DatagramST for Box<dyn Modulation + Send + Sync + 'a> {
    type G = ModulationOperationGenerator;

    fn operation_generator_with_segment(
        self,
        _: &Geometry,
        segment: Segment,
        transition_mode: Option<TransitionMode>,
    ) -> Result<Self::G, AUTDInternalError> {
        Ok(Self::G {
            g: self.calc()?,
            config: self.sampling_config(),
            loop_behavior: self.loop_behavior(),
            segment,
            transition_mode,
        })
    }

    fn timeout(&self) -> Option<Duration> {
        Some(DEFAULT_TIMEOUT)
    }

    fn parallel_threshold(&self) -> Option<usize> {
        Some(usize::MAX)
    }

    fn trace(&self, geometry: &Geometry) {
        self.as_ref().trace(geometry);
        if tracing::enabled!(tracing::Level::DEBUG) {
            if let Ok(buf) = <Self as Modulation>::calc(self) {
                match buf.len() {
                    0 => {
                        tracing::error!("Buffer is empty");
                    }
                    1 => {
                        tracing::debug!("Buffer: {:#04X}", buf[0]);
                    }
                    2 => {
                        tracing::debug!("Buffer: {:#04X}, {:#04X}", buf[0], buf[1]);
                    }
                    _ => {
                        if tracing::enabled!(tracing::Level::TRACE) {
                            tracing::debug!(
                                "Buffer: {}",
                                buf.iter()
                                    .format_with(", ", |elt, f| f(&format_args!("{:#04X}", elt)))
                            );
                        } else {
                            tracing::debug!(
                                "Buffer: {:#04X}, ..., {:#04X} ({})",
                                buf[0],
                                buf[buf.len() - 1],
                                buf.len()
                            );
                        }
                    }
                }
            } else {
                tracing::error!("Failed to calculate modulation");
            }
        }
    }
}

#[cfg(feature = "capi")]
mod capi {
    use crate::derive::*;

    #[derive(Modulation)]
    struct NullModulation {
        config: SamplingConfig,
        loop_behavior: LoopBehavior,
    }

    impl Modulation for NullModulation {
        fn calc(&self) -> ModulationCalcResult {
            Ok(Arc::new(vec![]))
        }
    }

    impl<'a> Default for Box<dyn Modulation + Send + Sync + 'a> {
        fn default() -> Self {
            Box::new(NullModulation {
                config: SamplingConfig::FREQ_4K,
                loop_behavior: LoopBehavior::infinite(),
            })
        }
    }
}
// GRCOV_EXCL_STOP

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

    #[derive(Modulation, Clone, PartialEq, Debug)]
    pub struct TestModulation {
        pub buf: Arc<Vec<u8>>,
        pub config: SamplingConfig,
        pub loop_behavior: LoopBehavior,
    }

    impl Modulation for TestModulation {
        fn calc(&self) -> ModulationCalcResult {
            Ok(self.buf.clone())
        }
    }
}