autd3-driver 38.1.0

AUTD3 driver
Documentation
use std::{convert::Infallible, mem::size_of};

use crate::{
    datagram::PhaseCorrection,
    firmware::{
        operation::{Operation, OperationGenerator, implement::null::NullOp},
        tag::TypeTag,
    },
};

use autd3_core::{
    firmware::Phase,
    geometry::{Device, Transducer},
};

#[repr(C, align(2))]
struct PhaseCorr {
    tag: TypeTag,
    __: u8,
}

pub struct PhaseCorrectionOp<F> {
    is_done: bool,
    f: F,
}

impl<'a, F: Fn(&'a Transducer) -> Phase> PhaseCorrectionOp<F> {
    pub(crate) const fn new(f: F) -> Self {
        Self { is_done: false, f }
    }
}

impl<'a, F: Fn(&'a Transducer) -> Phase + Send> Operation<'a> for PhaseCorrectionOp<F> {
    type Error = Infallible;

    fn pack(&mut self, dev: &'a Device, tx: &mut [u8]) -> Result<usize, Self::Error> {
        crate::firmware::operation::write_to_tx(
            tx,
            PhaseCorr {
                tag: TypeTag::PhaseCorrection,
                __: 0,
            },
        );

        tx[size_of::<PhaseCorr>()..]
            .chunks_mut(size_of::<Phase>())
            .zip(dev.iter())
            .for_each(|(dst, tr)| {
                crate::firmware::operation::write_to_tx(dst, (self.f)(tr));
            });

        self.is_done = true;

        Ok(size_of::<PhaseCorr>() + dev.num_transducers().div_ceil(2) * 2)
    }

    fn required_size(&self, dev: &Device) -> usize {
        size_of::<PhaseCorr>() + dev.num_transducers().div_ceil(2) * 2
    }

    fn is_done(&self) -> bool {
        self.is_done
    }
}

impl<'a, FT: Fn(&'a Transducer) -> Phase + Send, F: Fn(&'a Device) -> FT> OperationGenerator<'a>
    for PhaseCorrection<F, FT>
{
    type O1 = PhaseCorrectionOp<FT>;
    type O2 = NullOp;

    fn generate(&mut self, device: &'a Device) -> Option<(Self::O1, Self::O2)> {
        Some((Self::O1::new((self.f)(device)), Self::O2 {}))
    }
}

#[cfg(test)]
mod tests {
    use std::mem::size_of;

    use super::*;

    #[test]
    fn test() {
        let device = crate::tests::create_device();

        let mut tx = [0x00u8; 2 * (size_of::<PhaseCorr>() + 250)];

        let mut op = PhaseCorrectionOp::new(|tr| Phase(tr.idx() as _));

        assert_eq!(size_of::<PhaseCorr>() + 250, op.required_size(&device));
        assert!(!op.is_done());
        assert!(op.pack(&device, &mut tx).is_ok());
        assert!(op.is_done());
        assert_eq!(tx[0], TypeTag::PhaseCorrection as u8);
        assert!((0..249).all(|i| i as u8 == tx[size_of::<PhaseCorr>() + i]));
    }
}