autd 9.0.1

AUTD library 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
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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
/*
 * File: autd_logic.rs
 * Project: controller
 * Created Date: 30/12/2020
 * Author: Shun Suzuki
 * -----
 * Last Modified: 08/03/2021
 * Modified By: Shun Suzuki (suzuki@hapis.k.u-tokyo.ac.jp)
 * -----
 * Copyright (c) 2020 Hapis Lab. All rights reserved.
 *
 */

use std::{error::Error, mem::size_of, ptr::copy_nonoverlapping};

use crate::{
    core::{configuration::Configuration, consts::*, *},
    gain::Gain,
    geometry::Geometry,
    link::Link,
    modulation::Modulation,
    sequence::PointSequence,
    Float,
};

use super::{GainPtr, ModPtr};

pub struct AUTDLogic<L: Link> {
    geometry: Geometry,
    link: L,
    rx_data: Vec<u8>,
    seq_mode: bool,
    pub(crate) silent_mode: bool,
    config: Configuration,
}

impl<L: Link> AUTDLogic<L> {
    pub fn geometry(&self) -> &Geometry {
        &self.geometry
    }
}

impl<L: Link> AUTDLogic<L> {
    pub(crate) fn new(geometry: Geometry, link: L) -> Self {
        Self {
            geometry,
            link,
            rx_data: vec![],
            seq_mode: false,
            silent_mode: true,
            config: Configuration::default(),
        }
    }

    pub(crate) fn is_open(&self) -> bool {
        self.link.is_open()
    }

    pub(crate) fn build_gain<G: Gain>(&self, g: &mut G) {
        g.build(&self.geometry)
    }

    pub(crate) fn build_modulation<M: Modulation>(&self, m: &mut M) {
        m.build(self.config)
    }

    pub(crate) fn build_gain_ptr(&self, g: &mut GainPtr) {
        g.build(&self.geometry)
    }

    pub(crate) fn build_modulation_ptr(&self, m: &mut ModPtr) {
        m.build(self.config)
    }

    pub(crate) fn send_gain_mod<G: Gain, M: Modulation>(
        &mut self,
        g: Option<&G>,
        m: Option<&mut M>,
    ) -> Result<u8, Box<dyn Error>> {
        if g.is_some() {
            self.seq_mode = false;
        }

        let dev_num = self.geometry.num_devices();
        let (msg_id, body) = Self::make_body(g, m, dev_num, self.silent_mode, self.seq_mode);
        self.link.send(&body)?;
        Ok(msg_id)
    }

    pub(crate) fn send_gain_mod_ptr(
        &mut self,
        g: Option<GainPtr>,
        m: Option<&mut ModPtr>,
    ) -> Result<u8, Box<dyn Error>> {
        if g.is_some() {
            self.seq_mode = false;
        }

        let dev_num = self.geometry.num_devices();
        let (msg_id, body) = Self::make_body_ptr(g, m, dev_num, self.silent_mode, self.seq_mode);
        self.link.send(&body)?;
        Ok(msg_id)
    }

    pub(crate) fn send_gain_mod_blocking<G: Gain, M: Modulation>(
        &mut self,
        g: Option<&G>,
        m: Option<&mut M>,
    ) -> Result<bool, Box<dyn Error>> {
        let msg_id = self.send_gain_mod(g, m)?;
        let dev_num = self.geometry.num_devices();
        self.wait_msg_processed(dev_num, msg_id, 0xFF, 200)
    }

    pub(crate) fn send_seq_blocking(
        &mut self,
        seq: &mut PointSequence,
    ) -> Result<bool, Box<dyn Error>> {
        self.seq_mode = true;

        let (msg_id, body) = Self::make_seq_body(seq, &self.geometry, self.silent_mode);
        self.link.send(&body)?;

        let dev_num = self.geometry.num_devices();
        if *seq.sent() == seq.control_points().len() {
            self.wait_msg_processed(dev_num, 0xC0, 0xE0, 2000)
        } else {
            self.wait_msg_processed(dev_num, msg_id, 0xFF, 200)
        }
    }

    pub(crate) fn send_data(&mut self, data: &[u8]) -> Result<u8, Box<dyn Error>> {
        let msg_id = data[0];
        self.link.send(&data)?;
        Ok(msg_id)
    }

    fn send_header_blocking(
        &mut self,
        command: CommandType,
        max_trial: usize,
    ) -> Result<bool, Box<dyn Error>> {
        let header = RxGlobalHeader::new_with_cmd(command);
        let dev_num = self.geometry.num_devices();
        unsafe {
            self.link.send(Self::convert_to_u8_slice(&header))?;
        }
        self.wait_msg_processed(dev_num, command as u8, 0xFF, max_trial)
    }

    pub(crate) fn calibrate(&mut self, config: Configuration) -> Result<bool, Box<dyn Error>> {
        self.config = config;
        self.send_header_blocking(CommandType::CmdInitRefClock, 5000)
    }

    pub(crate) fn calibrate_seq(&mut self) -> Result<(), Box<dyn Error>> {
        let rx_data = &self.rx_data;
        let mut laps = Vec::with_capacity(rx_data.len() / 2);
        for j in 0..laps.capacity() {
            let lap_raw = ((rx_data[2 * j + 1] as u16) << 8) | rx_data[2 * j] as u16;
            laps.push(lap_raw & 0x03FF);
        }
        let minimum = laps.iter().min().unwrap();
        let diffs = laps.iter().map(|&d| d - minimum).collect::<Vec<_>>();
        let diff_max = *diffs.iter().max().unwrap();
        let diffs: Vec<u16> = if diff_max == 0 {
            return Ok(());
        } else if diff_max > 500 {
            let laps = laps
                .iter()
                .map(|&d| if d < 500 { d + 1000 } else { d })
                .collect::<Vec<_>>();
            let minimum = laps.iter().min().unwrap();
            laps.iter().map(|d| d - minimum).collect()
        } else {
            diffs
        };

        let dev_num = diffs.len();
        let calib_body = Self::make_calib_body(diffs);
        self.link.send(&calib_body)?;
        self.wait_msg_processed(dev_num, 0xE0, 0xE0, 200)?;

        Ok(())
    }

    pub(crate) fn clear(&mut self) -> Result<bool, Box<dyn Error>> {
        self.send_header_blocking(CommandType::CmdClear, 5000)
    }

    pub(crate) fn close(&mut self) -> Result<bool, Box<dyn Error>> {
        self.clear()?;
        self.link.close()?;
        Ok(true)
    }

    #[allow(clippy::needless_range_loop)]
    pub(crate) fn firmware_info_list(&mut self) -> Result<Vec<FirmwareInfo>, Box<dyn Error>> {
        let size = self.geometry.num_devices();

        let mut cpu_versions: Vec<u16> = vec![0x0000; size];
        let mut fpga_versions: Vec<u16> = vec![0x0000; size];

        self.send_header_blocking(CommandType::CmdReadCpuVerLsb, 50)?;
        for i in 0..size {
            cpu_versions[i] = self.rx_data[2 * i] as u16;
        }

        self.send_header_blocking(CommandType::CmdReadCpuVerMsb, 50)?;
        for i in 0..size {
            cpu_versions[i] |= (self.rx_data[2 * i] as u16) << 8;
        }

        self.send_header_blocking(CommandType::CmdReadFpgaVerLsb, 50)?;
        for i in 0..size {
            fpga_versions[i] = self.rx_data[2 * i] as u16;
        }

        self.send_header_blocking(CommandType::CmdReadFpgaVerMsb, 50)?;
        for i in 0..size {
            fpga_versions[i] |= (self.rx_data[2 * i] as u16) << 8;
        }

        let mut res = Vec::with_capacity(size);
        for i in 0..size {
            let firm_info = FirmwareInfo::new(i as u16, cpu_versions[i], fpga_versions[i]);
            res.push(firm_info);
        }

        Ok(res)
    }

    fn make_calib_body(diffs: Vec<u16>) -> Vec<u8> {
        let header = RxGlobalHeader::new_with_cmd(CommandType::CmdCalibSeqClock);
        let mut body =
            vec![0x00; size_of::<RxGlobalHeader>() + NUM_TRANS_IN_UNIT * 2 * diffs.len()];
        unsafe {
            copy_nonoverlapping(
                &header as *const RxGlobalHeader as *const u8,
                body.as_mut_ptr(),
                size_of::<RxGlobalHeader>(),
            );
            let mut cursor = size_of::<RxGlobalHeader>();
            for diff in diffs {
                body[cursor] = (diff & 0x00FF) as u8;
                body[cursor + 1] = ((diff & 0xFF00) >> 8) as u8;
                cursor += NUM_TRANS_IN_UNIT * 2;
            }
        }
        body
    }

    fn wait_msg_processed(
        &mut self,
        dev_num: usize,
        msg_id: u8,
        mask: u8,
        max_trial: usize,
    ) -> Result<bool, Box<dyn Error>> {
        let buffer_len = dev_num * INPUT_FRAME_SIZE;

        self.rx_data.resize(buffer_len, 0x00);
        for _ in 0..max_trial {
            self.link.read(&mut self.rx_data, buffer_len)?;

            let processed = (0..dev_num)
                .map(|dev| self.rx_data[dev as usize * INPUT_FRAME_SIZE + 1])
                .filter(|&proc_id| (proc_id & mask) == msg_id)
                .count();

            if processed == dev_num {
                return Ok(true);
            }

            let wait_t = (EC_TRAFFIC_DELAY * 1000.0 / EC_DEVICE_PER_FRAME as Float
                * dev_num as Float)
                .ceil() as u64;
            let wait_t = 1.max(wait_t);
            std::thread::sleep(std::time::Duration::from_millis(wait_t));
        }
        Ok(false)
    }

    fn make_body<G: Gain, M: Modulation>(
        gain: Option<&G>,
        m: Option<&mut M>,
        num_devices: usize,
        is_silent: bool,
        is_seq_mode: bool,
    ) -> (u8, Vec<u8>) {
        let num_bodies = if gain.is_some() { num_devices } else { 0 };
        let size = size_of::<RxGlobalHeader>() + NUM_TRANS_IN_UNIT * 2 * num_bodies;

        let mut body = vec![0x00; size];
        let mut ctrl_flags = RxGlobalControlFlags::NONE;
        if is_silent {
            ctrl_flags |= RxGlobalControlFlags::SILENT;
        }
        if is_seq_mode {
            ctrl_flags |= RxGlobalControlFlags::SEQ_MODE;
        }

        let mod_data = if let Some(modulation) = m {
            let sent = *modulation.sent();
            let mod_size = num::clamp(modulation.buffer().len() - sent, 0, MOD_FRAME_SIZE);
            if sent == 0 {
                ctrl_flags |= RxGlobalControlFlags::LOOP_BEGIN;
            }
            if sent + mod_size >= modulation.buffer().len() {
                ctrl_flags |= RxGlobalControlFlags::LOOP_END;
            }
            *modulation.sent() += mod_size;
            &modulation.buffer()[sent..(sent + mod_size)]
        } else {
            &[]
        };
        let msg_id = unsafe {
            let header = RxGlobalHeader::new_op(ctrl_flags, mod_data);
            let src_ptr = &header as *const RxGlobalHeader as *const u8;
            let dst_ptr = body.as_mut_ptr();
            copy_nonoverlapping(src_ptr, dst_ptr, size_of::<RxGlobalHeader>());
            header.msg_id
        };

        if let Some(gain) = gain {
            let mut cursor = size_of::<RxGlobalHeader>();
            let byte_size = NUM_TRANS_IN_UNIT * 2;
            let gain_ptr = gain.get_data().as_ptr() as *const u8;
            unsafe {
                for i in 0..num_devices {
                    let src_ptr = gain_ptr.add(i * byte_size);
                    let dst_ptr = body.as_mut_ptr().add(cursor);

                    copy_nonoverlapping(src_ptr, dst_ptr, byte_size);
                    cursor += byte_size;
                }
            }
        }

        (msg_id, body)
    }

    pub(crate) fn make_body_ptr(
        gain: Option<GainPtr>,
        m: Option<&mut ModPtr>,
        num_devices: usize,
        is_silent: bool,
        is_seq_mode: bool,
    ) -> (u8, Vec<u8>) {
        let num_bodies = if gain.is_some() { num_devices } else { 0 };
        let size = size_of::<RxGlobalHeader>() + NUM_TRANS_IN_UNIT * 2 * num_bodies;

        let mut body = vec![0x00; size];
        let mut ctrl_flags = RxGlobalControlFlags::NONE;
        if is_silent {
            ctrl_flags |= RxGlobalControlFlags::SILENT;
        }
        if is_seq_mode {
            ctrl_flags |= RxGlobalControlFlags::SEQ_MODE;
        }

        let mod_data = if let Some(modulation) = m {
            let sent = *modulation.sent();
            let mod_size = num::clamp(modulation.buffer().len() - sent, 0, MOD_FRAME_SIZE);
            if sent == 0 {
                ctrl_flags |= RxGlobalControlFlags::LOOP_BEGIN;
            }
            if sent + mod_size >= modulation.buffer().len() {
                ctrl_flags |= RxGlobalControlFlags::LOOP_END;
            }
            *modulation.sent() += mod_size;
            &modulation.buffer()[sent..(sent + mod_size)]
        } else {
            &[]
        };
        let msg_id = unsafe {
            let header = RxGlobalHeader::new_op(ctrl_flags, mod_data);
            let src_ptr = &header as *const RxGlobalHeader as *const u8;
            let dst_ptr = body.as_mut_ptr();
            copy_nonoverlapping(src_ptr, dst_ptr, size_of::<RxGlobalHeader>());
            header.msg_id
        };

        if let Some(gain) = gain {
            let mut cursor = size_of::<RxGlobalHeader>();
            let byte_size = NUM_TRANS_IN_UNIT * 2;
            let gain_ptr = gain.get_data().as_ptr() as *const u8;
            unsafe {
                for i in 0..num_devices {
                    let src_ptr = gain_ptr.add(i * byte_size);
                    let dst_ptr = body.as_mut_ptr().add(cursor);

                    copy_nonoverlapping(src_ptr, dst_ptr, byte_size);
                    cursor += byte_size;
                }
            }
        }
        (msg_id, body)
    }

    fn make_seq_body(
        seq: &mut PointSequence,
        geometry: &Geometry,
        is_silent: bool,
    ) -> (u8, Vec<u8>) {
        let num_devices = geometry.num_devices();
        let size = size_of::<RxGlobalHeader>() + NUM_TRANS_IN_UNIT * 2 * num_devices;

        let sent = *seq.sent();

        let mut body = vec![0x00; size];
        let send_size = num::clamp(seq.control_points().len() - sent, 0, 40);

        let mut ctrl_flags = RxGlobalControlFlags::SEQ_MODE;
        if is_silent {
            ctrl_flags |= RxGlobalControlFlags::SILENT;
        }

        if sent == 0 {
            ctrl_flags |= RxGlobalControlFlags::SEQ_BEGIN;
        }
        if sent + send_size >= seq.control_points().len() {
            ctrl_flags |= RxGlobalControlFlags::SEQ_END;
        }
        let msg_id = unsafe {
            let header =
                RxGlobalHeader::new_seq(ctrl_flags, send_size as u16, seq.sampling_freq_div());
            let src_ptr = &header as *const RxGlobalHeader as *const u8;
            let dst_ptr = body.as_mut_ptr();
            copy_nonoverlapping(src_ptr, dst_ptr, size_of::<RxGlobalHeader>());
            header.msg_id
        };

        let mut cursor = size_of::<RxGlobalHeader>();
        let fixed_num_unit: Float = geometry.wavelength() / 256.0;
        unsafe {
            for device in 0..num_devices {
                let mut foci = Vec::with_capacity(send_size as usize * 10);
                for i in 0..(send_size as usize) {
                    let v64 = geometry.local_position(device, seq.control_points()[sent + i]);
                    let x = (v64.x / fixed_num_unit) as i32 as u32;
                    let y = (v64.y / fixed_num_unit) as i32 as u32;
                    let z = (v64.z / fixed_num_unit) as i32 as u32;
                    foci.push((x & 0x000000FF) as u8);
                    foci.push(((x & 0x0000FF00) >> 8) as u8);
                    foci.push((((x & 0x80000000) >> 24) | ((x & 0x007F0000) >> 16)) as u8);
                    foci.push((y & 0x000000FF) as u8);
                    foci.push(((y & 0x0000FF00) >> 8) as u8);
                    foci.push((((y & 0x80000000) >> 24) | ((y & 0x007F0000) >> 16)) as u8);
                    foci.push((z & 0x000000FF) as u8);
                    foci.push(((z & 0x0000FF00) >> 8) as u8);
                    foci.push((((z & 0x80000000) >> 24) | ((z & 0x007F0000) >> 16)) as u8);
                    foci.push(0xFF); // amp
                }
                let src_ptr = foci.as_ptr() as *const u8;
                let dst_ptr = body.as_mut_ptr().add(cursor);

                copy_nonoverlapping(src_ptr, dst_ptr, foci.len());
                cursor += NUM_TRANS_IN_UNIT * 2;
            }
        }
        *seq.sent() += send_size;
        (msg_id, body)
    }

    unsafe fn convert_to_u8_slice<T: Sized>(p: &T) -> &[u8] {
        ::std::slice::from_raw_parts((p as *const T) as *const u8, ::std::mem::size_of::<T>())
    }
}