Support for baseband output to a soundcard

[m17rt] / m17app / src / app.rs

diff --git a/m17app/src/app.rs b/m17app/src/app.rs
index 0ad196d6dc217f41d40d0fbc97d9f95743d04ed4..561a2b7ae569b6266e6dc9d39a589fd18e712d0c 100644 (file)
--- a/m17app/src/app.rs
+++ b/m17app/src/app.rs
@@ -1,16 +1,15 @@
+use crate::adapter::{PacketAdapter, StreamAdapter};

 use crate::tnc::Tnc;
 use crate::tnc::Tnc;

-use m17core::kiss::KissFrame;
-use m17core::protocol::PacketType;
-use m17core::traits::{PacketListener, StreamListener};
+use m17core::kiss::{KissBuffer, KissCommand, KissFrame};
+use m17core::protocol::{EncryptionType, LsfFrame, PacketType, StreamFrame};

 
 use log::debug;
 use std::collections::HashMap;
 
 use log::debug;
 use std::collections::HashMap;

-use std::io::{Read, Write};

 use std::sync::mpsc;
 use std::sync::{Arc, RwLock};
 
 pub struct M17App {
 use std::sync::mpsc;
 use std::sync::{Arc, RwLock};
 
 pub struct M17App {

-    listeners: Arc<RwLock<Listeners>>,
+    adapters: Arc<RwLock<Adapters>>,

     event_tx: mpsc::SyncSender<TncControlEvent>,
 }
 
     event_tx: mpsc::SyncSender<TncControlEvent>,
 }
 


@@ -18,40 +17,71 @@ impl M17App {
     pub fn new<T: Tnc + Send + 'static>(mut tnc: T) -> Self {
         let write_tnc = tnc.try_clone().unwrap();
         let (event_tx, event_rx) = mpsc::sync_channel(128);
     pub fn new<T: Tnc + Send + 'static>(mut tnc: T) -> Self {
         let write_tnc = tnc.try_clone().unwrap();
         let (event_tx, event_rx) = mpsc::sync_channel(128);

-        let listeners = Arc::new(RwLock::new(Listeners::new()));
+        let listeners = Arc::new(RwLock::new(Adapters::new()));

         spawn_reader(tnc, listeners.clone());
         spawn_writer(write_tnc, event_rx);
         Self {
         spawn_reader(tnc, listeners.clone());
         spawn_writer(write_tnc, event_rx);
         Self {

-            listeners,
+            adapters: listeners,

             event_tx,
         }
     }
 
             event_tx,
         }
     }
 

-    pub fn add_packet_listener<P: PacketListener + 'static>(&self, listener: P) -> usize {
-        let mut listeners = self.listeners.write().unwrap();
-        let id = listeners.next;
-        listeners.next += 1;
-        listeners.packet.insert(id, Box::new(listener));
+    pub fn add_packet_adapter<P: PacketAdapter + 'static>(&self, adapter: P) -> usize {
+        let adapter = Arc::new(adapter);
+        let mut adapters = self.adapters.write().unwrap();
+        let id = adapters.next;
+        adapters.next += 1;
+        adapters.packet.insert(id, adapter.clone());
+        drop(adapters);
+        adapter.adapter_registered(id, self.tx());

         id
     }
 
         id
     }
 

-    pub fn add_stream_listener<S: StreamListener + 'static>(&self, listener: S) -> usize {
-        let mut listeners = self.listeners.write().unwrap();
-        let id = listeners.next;
-        listeners.next += 1;
-        listeners.stream.insert(id, Box::new(listener));
+    pub fn add_stream_adapter<S: StreamAdapter + 'static>(&self, adapter: S) -> usize {
+        let adapter = Arc::new(adapter);
+        let mut adapters = self.adapters.write().unwrap();
+        let id = adapters.next;
+        adapters.next += 1;
+        adapters.stream.insert(id, adapter.clone());
+        drop(adapters);
+        adapter.adapter_registered(id, self.tx());

         id
     }
 
         id
     }
 

-    pub fn remove_packet_listener(&self, id: usize) {
-        self.listeners.write().unwrap().packet.remove(&id);
+    pub fn remove_packet_adapter(&self, id: usize) {
+        if let Some(a) = self.adapters.write().unwrap().packet.remove(&id) {
+            a.adapter_removed();
+        }
+    }
+
+    pub fn remove_stream_adapter(&self, id: usize) {
+        if let Some(a) = self.adapters.write().unwrap().stream.remove(&id) {
+            a.adapter_removed();
+        }
+    }
+
+    /// Create a handle that can be used to transmit data on the TNC
+    pub fn tx(&self) -> TxHandle {
+        TxHandle {
+            event_tx: self.event_tx.clone(),
+        }
+    }
+
+    pub fn start(&self) {
+        let _ = self.event_tx.send(TncControlEvent::Start);

     }
 
     }
 

-    pub fn remove_stream_listener(&self, id: usize) {
-        self.listeners.write().unwrap().stream.remove(&id);
+    pub fn close(&self) {
+        let _ = self.event_tx.send(TncControlEvent::Close);

     }
     }

+}
+
+pub struct TxHandle {
+    event_tx: mpsc::SyncSender<TncControlEvent>,
+}

 
 

-    pub fn transmit_packet(&self, type_code: PacketType, payload: &[u8]) {
+impl TxHandle {
+    pub fn transmit_packet(&self, packet_type: PacketType, payload: &[u8]) {

         // hang on where do we get the LSF details from? We need a destination obviously
         // our source address needs to be configured here too
         // also there is possible CAN, encryption, meta payload
         // hang on where do we get the LSF details from? We need a destination obviously
         // our source address needs to be configured here too
         // also there is possible CAN, encryption, meta payload


@@ -61,32 +91,32 @@ impl M17App {
 
     // add more methods here for stream outgoing
 
 
     // add more methods here for stream outgoing
 

-    pub fn transmit_stream_start(&self /* lsf?, payload? what needs to be configured ?! */) {}
+    pub fn transmit_stream_start(&self, lsf: LsfFrame) {
+        // TODO: is asking for an LsfFrame a good idea or unfriendly API?
+        // What I should do here is create a LinkSetup struct which wraps an LsfFrame and can be loaded with a raw one
+        let kiss_frame = KissFrame::new_stream_setup(&lsf.0).unwrap();
+        let _ = self.event_tx.send(TncControlEvent::Kiss(kiss_frame));
+    }

 
     // as long as there is only one TNC it is implied there is only ever one stream transmission in flight
 
 
     // as long as there is only one TNC it is implied there is only ever one stream transmission in flight
 

-    pub fn transmit_stream_next(&self, /* next payload,  */ end_of_stream: bool) {}
-
-    pub fn start(&self) {
-        let _ = self.event_tx.send(TncControlEvent::Start);
-    }
-
-    pub fn close(&self) {
-        let _ = self.event_tx.send(TncControlEvent::Close);
+    pub fn transmit_stream_next(&self, stream: StreamFrame) {
+        let kiss_frame = KissFrame::new_stream_data(&stream).unwrap();
+        let _ = self.event_tx.send(TncControlEvent::Kiss(kiss_frame));

     }
 }
 
 /// Synchronised structure for listeners subscribing to packets and streams.
 ///
 /// Each listener will be notified in turn of each event.
     }
 }
 
 /// Synchronised structure for listeners subscribing to packets and streams.
 ///
 /// Each listener will be notified in turn of each event.

-struct Listeners {
+struct Adapters {

     /// Identifier to be assigned to the next listener, starting from 0
     next: usize,
     /// Identifier to be assigned to the next listener, starting from 0
     next: usize,

-    packet: HashMap<usize, Box<dyn PacketListener>>,
-    stream: HashMap<usize, Box<dyn StreamListener>>,
+    packet: HashMap<usize, Arc<dyn PacketAdapter>>,
+    stream: HashMap<usize, Arc<dyn StreamAdapter>>,

 }
 
 }
 

-impl Listeners {
+impl Adapters {

     fn new() -> Self {
         Self {
             next: 0,
     fn new() -> Self {
         Self {
             next: 0,


@@ -103,27 +133,123 @@ enum TncControlEvent {
     Close,
 }
 
     Close,
 }
 

-fn spawn_reader<T: Tnc + Send + 'static>(mut tnc: T, listeners: Arc<RwLock<Listeners>>) {
+fn spawn_reader<T: Tnc>(mut tnc: T, adapters: Arc<RwLock<Adapters>>) {

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

-        let mut buf = [0u8; 1713];
-        let mut n = 0;
+        let mut kiss_buffer = KissBuffer::new();
+        let mut stream_running = false;

         loop {
         loop {

-            // I want to call tnc.read() here
-            // Probably these needs a helper in m17core::kiss? It will be common to both TNC and host
-
-            // After a read...
-            // if this does not start with FEND, forget all data up until first FEND
-            // if we start with a FEND, see if there is another FEND with at least one byte between
-            // for each such case, turn that FEND..=FEND slice into a KissFrame and attempt to parse it
-            // once all such pairs have been handled...
-            // move the last FEND onwards back to the start of the buffer
-            //   - if there is no room to do so, this is an oversize frame. purge everything and carry on.
-            // perform next read from end
+            let mut buf = kiss_buffer.buf_remaining();
+            let n = match tnc.read(&mut buf) {
+                Ok(n) => n,
+                Err(_) => break,
+            };
+            kiss_buffer.did_write(n);
+            while let Some(frame) = kiss_buffer.next_frame() {
+                if frame.command() != Ok(KissCommand::DataFrame) {
+                    continue;
+                }
+                match frame.port() {
+                    Ok(m17core::kiss::PORT_PACKET_BASIC) => {
+                        // no action
+                        // we will handle the more full-featured version from from port 1
+                    }
+                    Ok(m17core::kiss::PORT_PACKET_FULL) => {
+                        let mut payload = [0u8; 855]; // 30 byte LSF + 825 byte packet including CRC
+                        let Ok(n) = frame.decode_payload(&mut payload) else {
+                            debug!("failed to decode payload from KISS frame");
+                            continue;
+                        };
+                        if n < 33 {
+                            debug!("unusually short full packet frame");
+                            continue;
+                        }
+                        let lsf = LsfFrame(payload[0..30].try_into().unwrap());
+                        if lsf.check_crc() != 0 {
+                            debug!("LSF in full packet frame did not pass CRC");
+                            continue;
+                        }
+                        if lsf.encryption_type() != EncryptionType::None {
+                            debug!("we only understand None encryption for now - skipping packet");
+                            continue;
+                        }
+                        let Some((packet_type, type_len)) = PacketType::from_proto(&payload[30..n])
+                        else {
+                            debug!("failed to decode packet type");
+                            continue;
+                        };
+                        if (n - 30 - type_len) < 2 {
+                            debug!("packet payload too small to provide CRC");
+                            continue;
+                        }
+                        let packet_crc = m17core::crc::m17_crc(&payload[30..n]);
+                        if packet_crc != 0 {
+                            debug!("packet CRC does not pass");
+                            continue;
+                        }
+                        let packet_payload: Arc<[u8]> =
+                            Arc::from(&payload[(30 + type_len)..(n - 2)]);
+
+                        let subs: Vec<_> =
+                            adapters.read().unwrap().packet.values().cloned().collect();
+                        for s in subs {
+                            s.packet_received(
+                                lsf.clone(),
+                                packet_type.clone(),
+                                packet_payload.clone(),
+                            );
+                        }
+                    }
+                    Ok(m17core::kiss::PORT_STREAM) => {
+                        let mut payload = [0u8; 32];
+                        let Ok(n) = frame.decode_payload(&mut payload) else {
+                            debug!("failed to decode stream payload from KISS frame");
+                            continue;
+                        };
+                        if n == 30 {
+                            let lsf = LsfFrame(payload[0..30].try_into().unwrap());
+                            if lsf.check_crc() != 0 {
+                                debug!("initial LSF in stream did not pass CRC");
+                                continue;
+                            }
+                            stream_running = true;
+                            let subs: Vec<_> =
+                                adapters.read().unwrap().stream.values().cloned().collect();
+                            for s in subs {
+                                s.stream_began(lsf.clone());
+                            }
+                        } else if n == 26 {
+                            if !stream_running {
+                                debug!("ignoring stream data as we didn't get a valid LSF first");
+                                continue;
+                            }
+                            // TODO: parse LICH and handle the different changing subvalues META could have
+                            if m17core::crc::m17_crc(&payload[6..n]) != 0 {
+                                debug!("stream data CRC mismatch");
+                                continue;
+                            }
+                            let mut frame_number = u16::from_be_bytes([payload[6], payload[7]]);
+                            let is_final = (frame_number & 0x8000) > 0;
+                            frame_number &= 0x7fff;
+                            let data: [u8; 16] = payload[8..24].try_into().unwrap();
+                            let data = Arc::new(data);
+                            if is_final {
+                                stream_running = false;
+                            }
+                            let subs: Vec<_> =
+                                adapters.read().unwrap().stream.values().cloned().collect();
+                            for s in subs {
+                                s.stream_data(frame_number, is_final, data.clone());
+                            }
+                        }
+                    }
+                    _ => (),
+                }
+            }

         }
     });
 }
 
         }
     });
 }
 

-fn spawn_writer<T: Tnc + Send + 'static>(mut tnc: T, event_rx: mpsc::Receiver<TncControlEvent>) {
+fn spawn_writer<T: Tnc>(mut tnc: T, event_rx: mpsc::Receiver<TncControlEvent>) {

     std::thread::spawn(move || {
         while let Ok(ev) = event_rx.recv() {
             match ev {
     std::thread::spawn(move || {
         while let Ok(ev) = event_rx.recv() {
             match ev {