Correctly call all adapter lifecycle methods, docs and test

[m17rt] / m17app / src / soundmodem.rs

diff --git a/m17app/src/soundmodem.rs b/m17app/src/soundmodem.rs
index 99085a0f72e34d0035be3f596faeb62e2749cd33..16bb97642900e86139c5d22aab31a681b0b53c2d 100644 (file)
--- a/m17app/src/soundmodem.rs
+++ b/m17app/src/soundmodem.rs
@@ -1,8 +1,5 @@
+use crate::error::M17Error;

 use crate::tnc::{Tnc, TncError};
 use crate::tnc::{Tnc, TncError};

-use cpal::traits::DeviceTrait;
-use cpal::traits::HostTrait;
-use cpal::traits::StreamTrait;
-use cpal::{SampleFormat, SampleRate};

 use log::debug;
 use m17core::kiss::MAX_FRAME_LEN;
 use m17core::modem::{Demodulator, Modulator, ModulatorAction, SoftDemodulator, SoftModulator};
 use log::debug;
 use m17core::kiss::MAX_FRAME_LEN;
 use m17core::modem::{Demodulator, Modulator, ModulatorAction, SoftDemodulator, SoftModulator};


@@ -23,7 +20,7 @@ pub struct Soundmodem {
 }
 
 impl Soundmodem {
 }
 
 impl Soundmodem {

-    pub fn new_with_input_and_output<I: InputSource, O: OutputSink>(input: I, output: O) -> Self {
+    pub fn new<I: InputSource, O: OutputSink, P: Ptt>(input: I, output: O, ptt: P) -> Self {

         // must create TNC here
         let (event_tx, event_rx) = sync_channel(128);
         let (kiss_out_tx, kiss_out_rx) = sync_channel(128);
         // must create TNC here
         let (event_tx, event_rx) = sync_channel(128);
         let (kiss_out_tx, kiss_out_rx) = sync_channel(128);


@@ -33,6 +30,7 @@ impl Soundmodem {
             kiss_out_tx,
             Box::new(input),
             Box::new(output),
             kiss_out_tx,
             Box::new(input),
             Box::new(output),

+            Box::new(ptt),

         );
         Self {
             event_tx,
         );
         Self {
             event_tx,


@@ -127,6 +125,7 @@ fn spawn_soundmodem_worker(
     kiss_out_tx: SyncSender<Arc<[u8]>>,
     input: Box<dyn InputSource>,
     output: Box<dyn OutputSink>,
     kiss_out_tx: SyncSender<Arc<[u8]>>,
     input: Box<dyn InputSource>,
     output: Box<dyn OutputSink>,

+    mut ptt_driver: Box<dyn Ptt>,

 ) {
     std::thread::spawn(move || {
         // TODO: should be able to provide a custom Demodulator for a soundmodem
 ) {
     std::thread::spawn(move || {
         // TODO: should be able to provide a custom Demodulator for a soundmodem


@@ -140,8 +139,12 @@ fn spawn_soundmodem_worker(
         let mut ptt = false;
         while let Ok(ev) = event_rx.recv() {
             // Update clock on TNC before we do anything
         let mut ptt = false;
         while let Ok(ev) = event_rx.recv() {
             // Update clock on TNC before we do anything

-            let sample_time = (start.elapsed().as_nanos() / 48000) as u64;
-            tnc.set_now(sample_time);
+            let sample_time = start.elapsed();
+            let secs = sample_time.as_secs();
+            let nanos = sample_time.subsec_nanos();
+            // Accurate to within approx 1 sample
+            let now_samples = 48000 * secs + (nanos as u64 / 20833);
+            tnc.set_now(now_samples);

 
             // Handle event
             match ev {
 
             // Handle event
             match ev {


@@ -170,7 +173,10 @@ fn spawn_soundmodem_worker(
                     input.start(event_tx.clone());
                     output.start(event_tx.clone(), out_buffer.clone());
                 }
                     input.start(event_tx.clone());
                     output.start(event_tx.clone(), out_buffer.clone());
                 }

-                SoundmodemEvent::Close => break,
+                SoundmodemEvent::Close => {
+                    ptt_driver.ptt_off();
+                    break;
+                }

                 SoundmodemEvent::DidReadFromOutputBuffer { len, timestamp } => {
                     let (occupied, internal_latency) = {
                         let out_buffer = out_buffer.read().unwrap();
                 SoundmodemEvent::DidReadFromOutputBuffer { len, timestamp } => {
                     let (occupied, internal_latency) = {
                         let out_buffer = out_buffer.read().unwrap();


@@ -194,9 +200,9 @@ fn spawn_soundmodem_worker(
             let new_ptt = tnc.ptt();
             if new_ptt != ptt {
                 if new_ptt {
             let new_ptt = tnc.ptt();
             if new_ptt != ptt {
                 if new_ptt {

-                    // turn it on
+                    ptt_driver.ptt_on();

                 } else {
                 } else {

-                    // turn it off
+                    ptt_driver.ptt_off();

                 }
             }
             ptt = new_ptt;
                 }
             }
             ptt = new_ptt;


@@ -234,64 +240,55 @@ pub trait InputSource: Send + Sync + 'static {
     fn close(&self);
 }
 
     fn close(&self);
 }
 

-pub struct InputSoundcard {
-    // TODO: allow for inversion both here and in output
-    cpal_name: Option<String>,
+pub struct InputRrcFile {
+    baseband: Arc<[u8]>,

     end_tx: Mutex<Option<Sender<()>>>,
 }
 
     end_tx: Mutex<Option<Sender<()>>>,
 }
 

-impl InputSoundcard {
-    pub fn new() -> Self {
-        Self {
-            cpal_name: None,
-            end_tx: Mutex::new(None),
-        }
-    }
-
-    pub fn new_with_card(card_name: String) -> Self {
-        Self {
-            cpal_name: Some(card_name),
+impl InputRrcFile {
+    pub fn new(path: PathBuf) -> Result<Self, M17Error> {
+        let mut file = File::open(&path).map_err(|_| M17Error::InvalidRrcPath(path.clone()))?;
+        let mut baseband = vec![];
+        file.read_to_end(&mut baseband)
+            .map_err(|_| M17Error::RrcReadFailed(path))?;
+        Ok(Self {
+            baseband: baseband.into(),

             end_tx: Mutex::new(None),
             end_tx: Mutex::new(None),

-        }
+        })

     }
 }
 
     }
 }
 

-impl InputSource for InputSoundcard {
+impl InputSource for InputRrcFile {

     fn start(&self, samples: SyncSender<SoundmodemEvent>) {
         let (end_tx, end_rx) = channel();
     fn start(&self, samples: SyncSender<SoundmodemEvent>) {
         let (end_tx, end_rx) = channel();

-        let cpal_name = self.cpal_name.clone();
+        let baseband = self.baseband.clone();

         std::thread::spawn(move || {
         std::thread::spawn(move || {

-            let host = cpal::default_host();
-            let device = if let Some(name) = cpal_name.as_deref() {
-                host.input_devices()
-                    .unwrap()
-                    .find(|d| d.name().unwrap() == name)
-                    .unwrap()
-            } else {
-                host.default_input_device().unwrap()
-            };
-            let mut configs = device.supported_input_configs().unwrap();
-            let config = configs
-                .find(|c| c.channels() == 1 && c.sample_format() == SampleFormat::I16)
-                .unwrap()
-                .with_sample_rate(SampleRate(48000));
-            let stream = device
-                .build_input_stream(
-                    &config.into(),
-                    move |data: &[i16], _info: &cpal::InputCallbackInfo| {
-                        debug!("input has given us {} samples", data.len());
-                        let out: Vec<i16> = data.iter().map(|s| *s).collect();
-                        let _ = samples.try_send(SoundmodemEvent::BasebandInput(out.into()));
-                    },
-                    |e| {
-                        // TODO: abort?
-                        debug!("error occurred in soundcard input: {e:?}");
-                    },
-                    None,
-                )
-                .unwrap();
-            stream.play().unwrap();
-            let _ = end_rx.recv();
+            // assuming 48 kHz for now
+            const TICK: Duration = Duration::from_millis(25);
+            const SAMPLES_PER_TICK: usize = 1200;
+
+            let mut next_tick = Instant::now() + TICK;
+            let mut buf = [0i16; SAMPLES_PER_TICK];
+            let mut idx = 0;
+
+            for sample in baseband
+                .chunks(2)
+                .map(|pair| i16::from_le_bytes([pair[0], pair[1]]))
+            {
+                buf[idx] = sample;
+                idx += 1;
+                if idx == SAMPLES_PER_TICK {
+                    if let Err(e) = samples.try_send(SoundmodemEvent::BasebandInput(buf.into())) {
+                        debug!("overflow feeding soundmodem: {e:?}");
+                    }
+                    next_tick += TICK;
+                    idx = 0;
+                    std::thread::sleep(next_tick.duration_since(Instant::now()));
+                }
+                if end_rx.try_recv() != Err(TryRecvError::Empty) {
+                    break;
+                }
+            }

         });
         *self.end_tx.lock().unwrap() = Some(end_tx);
     }
         });
         *self.end_tx.lock().unwrap() = Some(end_tx);
     }


@@ -301,55 +298,38 @@ impl InputSource for InputSoundcard {
     }
 }
 
     }
 }
 

-pub struct InputRrcFile {
-    path: PathBuf,
+pub struct NullInputSource {

     end_tx: Mutex<Option<Sender<()>>>,
 }
 
     end_tx: Mutex<Option<Sender<()>>>,
 }
 

-impl InputRrcFile {
-    pub fn new(path: PathBuf) -> Self {
+impl NullInputSource {
+    pub fn new() -> Self {

         Self {
         Self {

-            path,

             end_tx: Mutex::new(None),
         }
     }
 }
 
             end_tx: Mutex::new(None),
         }
     }
 }
 

-impl InputSource for InputRrcFile {
+impl InputSource for NullInputSource {

     fn start(&self, samples: SyncSender<SoundmodemEvent>) {
         let (end_tx, end_rx) = channel();
     fn start(&self, samples: SyncSender<SoundmodemEvent>) {
         let (end_tx, end_rx) = channel();

-        let path = self.path.clone();

         std::thread::spawn(move || {
         std::thread::spawn(move || {

-            // TODO: error handling
-            let mut file = File::open(path).unwrap();
-            let mut baseband = vec![];
-            file.read_to_end(&mut baseband).unwrap();
-

             // assuming 48 kHz for now
             const TICK: Duration = Duration::from_millis(25);
             const SAMPLES_PER_TICK: usize = 1200;
             // assuming 48 kHz for now
             const TICK: Duration = Duration::from_millis(25);
             const SAMPLES_PER_TICK: usize = 1200;

-

             let mut next_tick = Instant::now() + TICK;
             let mut next_tick = Instant::now() + TICK;

-            let mut buf = [0i16; SAMPLES_PER_TICK];
-            let mut idx = 0;

 
 

-            for sample in baseband
-                .chunks(2)
-                .map(|pair| i16::from_le_bytes([pair[0], pair[1]]))
-            {
-                buf[idx] = sample;
-                idx += 1;
-                if idx == SAMPLES_PER_TICK {
-                    if let Err(e) = samples.try_send(SoundmodemEvent::BasebandInput(buf.into())) {
-                        debug!("overflow feeding soundmodem: {e:?}");
-                    }
-                    next_tick = next_tick + TICK;
-                    idx = 0;
-                    std::thread::sleep(next_tick.duration_since(Instant::now()));
-                }
+            loop {
+                std::thread::sleep(next_tick.duration_since(Instant::now()));
+                next_tick += TICK;

                 if end_rx.try_recv() != Err(TryRecvError::Empty) {
                     break;
                 }
                 if end_rx.try_recv() != Err(TryRecvError::Empty) {
                     break;
                 }

+                if let Err(e) = samples.try_send(SoundmodemEvent::BasebandInput(
+                    [0i16; SAMPLES_PER_TICK].into(),
+                )) {
+                    debug!("overflow feeding soundmodem: {e:?}");
+                }

             }
         });
         *self.end_tx.lock().unwrap() = Some(end_tx);
             }
         });
         *self.end_tx.lock().unwrap() = Some(end_tx);


@@ -360,11 +340,17 @@ impl InputSource for InputRrcFile {
     }
 }
 
     }
 }
 

+impl Default for NullInputSource {
+    fn default() -> Self {
+        Self::new()
+    }
+}
+

 pub struct OutputBuffer {
 pub struct OutputBuffer {

-    idling: bool,
+    pub idling: bool,

     // TODO: something more efficient
     // TODO: something more efficient

-    samples: VecDeque<i16>,
-    latency: Duration,
+    pub samples: VecDeque<i16>,
+    pub latency: Duration,

 }
 
 impl OutputBuffer {
 }
 
 impl OutputBuffer {


@@ -377,6 +363,12 @@ impl OutputBuffer {
     }
 }
 
     }
 }
 

+impl Default for OutputBuffer {
+    fn default() -> Self {
+        Self::new()
+    }
+}
+

 pub trait OutputSink: Send + Sync + 'static {
     fn start(&self, event_tx: SyncSender<SoundmodemEvent>, buffer: Arc<RwLock<OutputBuffer>>);
     fn close(&self);
 pub trait OutputSink: Send + Sync + 'static {
     fn start(&self, event_tx: SyncSender<SoundmodemEvent>, buffer: Arc<RwLock<OutputBuffer>>);
     fn close(&self);


@@ -414,28 +406,34 @@ impl OutputSink for OutputRrcFile {
 
             loop {
                 std::thread::sleep(next_tick.duration_since(Instant::now()));
 
             loop {
                 std::thread::sleep(next_tick.duration_since(Instant::now()));

-                next_tick = next_tick + TICK;
+                next_tick += TICK;

                 if end_rx.try_recv() != Err(TryRecvError::Empty) {
                     break;
                 }
                 if end_rx.try_recv() != Err(TryRecvError::Empty) {
                     break;
                 }

+                // For now only write deliberately modulated (non-idling) samples
+                // Multiple transmissions will get smooshed together
+                let mut buf_used = 0;

 
                 let mut buffer = buffer.write().unwrap();
                 for out in buf.chunks_mut(2) {
                     if let Some(s) = buffer.samples.pop_front() {
 
                 let mut buffer = buffer.write().unwrap();
                 for out in buf.chunks_mut(2) {
                     if let Some(s) = buffer.samples.pop_front() {

-                        let be = s.to_be_bytes();
+                        let be = s.to_le_bytes();

                         out.copy_from_slice(&[be[0], be[1]]);
                         out.copy_from_slice(&[be[0], be[1]]);

-                    } else if buffer.idling {
-                        out.copy_from_slice(&[0, 0]);
-                    } else {
+                        buf_used += 2;
+                    } else if !buffer.idling {

                         debug!("output rrc file had underrun");
                         let _ = event_tx.send(SoundmodemEvent::OutputUnderrun);
                         break;
                     }
                 }
                         debug!("output rrc file had underrun");
                         let _ = event_tx.send(SoundmodemEvent::OutputUnderrun);
                         break;
                     }
                 }

-                if let Err(e) = file.write_all(&buf) {
+                if let Err(e) = file.write_all(&buf[0..buf_used]) {

                     debug!("failed to write to rrc file: {e:?}");
                     break;
                 }
                     debug!("failed to write to rrc file: {e:?}");
                     break;
                 }

+                let _ = event_tx.send(SoundmodemEvent::DidReadFromOutputBuffer {
+                    len: buf_used / 2,
+                    timestamp: Instant::now(),
+                });

             }
         });
         *self.end_tx.lock().unwrap() = Some(end_tx);
             }
         });
         *self.end_tx.lock().unwrap() = Some(end_tx);


@@ -458,6 +456,12 @@ impl NullOutputSink {
     }
 }
 
     }
 }
 

+impl Default for NullOutputSink {
+    fn default() -> Self {
+        Self::new()
+    }
+}
+

 impl OutputSink for NullOutputSink {
     fn start(&self, event_tx: SyncSender<SoundmodemEvent>, buffer: Arc<RwLock<OutputBuffer>>) {
         let (end_tx, end_rx) = channel();
 impl OutputSink for NullOutputSink {
     fn start(&self, event_tx: SyncSender<SoundmodemEvent>, buffer: Arc<RwLock<OutputBuffer>>) {
         let (end_tx, end_rx) = channel();


@@ -469,19 +473,28 @@ impl OutputSink for NullOutputSink {
 
             loop {
                 std::thread::sleep(next_tick.duration_since(Instant::now()));
 
             loop {
                 std::thread::sleep(next_tick.duration_since(Instant::now()));

-                next_tick = next_tick + TICK;
+                next_tick += TICK;

                 if end_rx.try_recv() != Err(TryRecvError::Empty) {
                     break;
                 }
 
                 let mut buffer = buffer.write().unwrap();
                 if end_rx.try_recv() != Err(TryRecvError::Empty) {
                     break;
                 }
 
                 let mut buffer = buffer.write().unwrap();

+                let mut taken = 0;

                 for _ in 0..SAMPLES_PER_TICK {
                 for _ in 0..SAMPLES_PER_TICK {

-                    if !buffer.samples.pop_front().is_some() && !buffer.idling {
-                        debug!("null output had underrun");
-                        let _ = event_tx.send(SoundmodemEvent::OutputUnderrun);
-                        break;
+                    if buffer.samples.pop_front().is_none() {
+                        if !buffer.idling {
+                            debug!("null output had underrun");
+                            let _ = event_tx.send(SoundmodemEvent::OutputUnderrun);
+                            break;
+                        }
+                    } else {
+                        taken += 1;

                     }
                 }
                     }
                 }

+                let _ = event_tx.send(SoundmodemEvent::DidReadFromOutputBuffer {
+                    len: taken,
+                    timestamp: Instant::now(),
+                });

             }
         });
         *self.end_tx.lock().unwrap() = Some(end_tx);
             }
         });
         *self.end_tx.lock().unwrap() = Some(end_tx);


@@ -491,3 +504,28 @@ impl OutputSink for NullOutputSink {
         let _ = self.end_tx.lock().unwrap().take();
     }
 }
         let _ = self.end_tx.lock().unwrap().take();
     }
 }

+
+pub trait Ptt: Send + 'static {
+    fn ptt_on(&mut self);
+    fn ptt_off(&mut self);
+}
+
+/// There is no PTT because this TNC will never make transmissions on a real radio.
+pub struct NullPtt;
+
+impl NullPtt {
+    pub fn new() -> Self {
+        Self
+    }
+}
+
+impl Default for NullPtt {
+    fn default() -> Self {
+        Self::new()
+    }
+}
+
+impl Ptt for NullPtt {
+    fn ptt_on(&mut self) {}
+    fn ptt_off(&mut self) {}
+}