+use crate::error::{M17Error, SoundmodemError};
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 m17core::tnc::SoftTnc;
use std::sync::RwLock;
use std::sync::{Arc, Mutex};
use std::time::{Duration, Instant};
+use thiserror::Error;
pub struct Soundmodem {
event_tx: SyncSender<SoundmodemEvent>,
kiss_out_rx: Arc<Mutex<Receiver<Arc<[u8]>>>>,
partial_kiss_out: Arc<Mutex<Option<PartialKissOut>>>,
+ error_handler: ErrorHandlerInternal,
}
impl Soundmodem {
- pub fn new_with_input_and_output<I: InputSource, O: OutputSink>(input: I, output: O) -> Self {
- // must create TNC here
+ pub fn new<I: InputSource, O: OutputSink, P: Ptt, E: ErrorHandler>(
+ input: I,
+ output: O,
+ ptt: P,
+ error: E,
+ ) -> Self {
let (event_tx, event_rx) = sync_channel(128);
let (kiss_out_tx, kiss_out_rx) = sync_channel(128);
+ let runtime_error_handler: ErrorHandlerInternal = Arc::new(Mutex::new(Box::new(error)));
spawn_soundmodem_worker(
event_tx.clone(),
event_rx,
kiss_out_tx,
Box::new(input),
Box::new(output),
+ Box::new(ptt),
+ runtime_error_handler.clone(),
);
Self {
event_tx,
kiss_out_rx: Arc::new(Mutex::new(kiss_out_rx)),
partial_kiss_out: Arc::new(Mutex::new(None)),
+ error_handler: runtime_error_handler,
}
}
}
+#[derive(Debug, Clone, Copy)]
+pub enum ErrorSource {
+ Input,
+ Output,
+ Ptt,
+}
+
+pub trait ErrorHandler: Send + Sync + 'static {
+ fn soundmodem_error(&mut self, source: ErrorSource, err: SoundmodemError);
+}
+
+impl<F> ErrorHandler for F
+where
+ F: FnMut(ErrorSource, SoundmodemError) + Send + Sync + 'static,
+{
+ fn soundmodem_error(&mut self, source: ErrorSource, err: SoundmodemError) {
+ self(source, err)
+ }
+}
+
+pub struct NullErrorHandler;
+
+impl NullErrorHandler {
+ pub fn new() -> Self {
+ Self {}
+ }
+}
+
+impl Default for NullErrorHandler {
+ fn default() -> Self {
+ Self::new()
+ }
+}
+
+impl ErrorHandler for NullErrorHandler {
+ fn soundmodem_error(&mut self, source: ErrorSource, err: SoundmodemError) {
+ let _ = source;
+ let _ = err;
+ }
+}
+
+type ErrorHandlerInternal = Arc<Mutex<Box<dyn ErrorHandler>>>;
+
+#[derive(Clone)]
+pub struct SoundmodemErrorSender {
+ source: ErrorSource,
+ event_tx: SyncSender<SoundmodemEvent>,
+}
+
+impl SoundmodemErrorSender {
+ pub fn send_error<E: Into<SoundmodemError>>(&self, err: E) {
+ let _ = self
+ .event_tx
+ .send(SoundmodemEvent::RuntimeError(self.source, err.into()));
+ }
+}
+
struct PartialKissOut {
output: Arc<[u8]>,
idx: usize,
event_tx: self.event_tx.clone(),
kiss_out_rx: self.kiss_out_rx.clone(),
partial_kiss_out: self.partial_kiss_out.clone(),
+ error_handler: self.error_handler.clone(),
})
}
- fn start(&mut self) -> Result<(), TncError> {
+ fn start(&mut self) {
let _ = self.event_tx.send(SoundmodemEvent::Start);
- Ok(())
}
- fn close(&mut self) -> Result<(), TncError> {
+ fn close(&mut self) {
let _ = self.event_tx.send(SoundmodemEvent::Close);
- Ok(())
}
}
Close,
DidReadFromOutputBuffer { len: usize, timestamp: Instant },
OutputUnderrun,
+ RuntimeError(ErrorSource, SoundmodemError),
}
fn spawn_soundmodem_worker(
kiss_out_tx: SyncSender<Arc<[u8]>>,
input: Box<dyn InputSource>,
output: Box<dyn OutputSink>,
+ mut ptt_driver: Box<dyn Ptt>,
+ error_handler: ErrorHandlerInternal,
) {
std::thread::spawn(move || {
// TODO: should be able to provide a custom Demodulator for a soundmodem
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 {
tnc.set_data_carrier_detect(demodulator.data_carrier_detect());
}
SoundmodemEvent::Start => {
- input.start(event_tx.clone());
- output.start(event_tx.clone(), out_buffer.clone());
+ let input_errors = SoundmodemErrorSender {
+ source: ErrorSource::Input,
+ event_tx: event_tx.clone(),
+ };
+ input.start(event_tx.clone(), input_errors);
+ let output_errors = SoundmodemErrorSender {
+ source: ErrorSource::Output,
+ event_tx: event_tx.clone(),
+ };
+ output.start(event_tx.clone(), out_buffer.clone(), output_errors);
+ }
+ SoundmodemEvent::Close => {
+ input.close();
+ output.close();
+ if let Err(e) = ptt_driver.ptt_off() {
+ error_handler
+ .lock()
+ .unwrap()
+ .soundmodem_error(ErrorSource::Ptt, e);
+ }
+ break;
}
- SoundmodemEvent::Close => break,
SoundmodemEvent::DidReadFromOutputBuffer { len, timestamp } => {
let (occupied, internal_latency) = {
let out_buffer = out_buffer.read().unwrap();
);
}
SoundmodemEvent::OutputUnderrun => {
+ log::debug!("output underrun");
// TODO: cancel transmission, send empty data frame to host
}
+ SoundmodemEvent::RuntimeError(source, err) => {
+ error_handler.lock().unwrap().soundmodem_error(source, err);
+ }
}
// Update PTT state
let new_ptt = tnc.ptt();
if new_ptt != ptt {
if new_ptt {
- // turn it on
- } else {
- // turn it off
+ if let Err(e) = ptt_driver.ptt_on() {
+ error_handler
+ .lock()
+ .unwrap()
+ .soundmodem_error(ErrorSource::Ptt, e);
+ }
+ } else if let Err(e) = ptt_driver.ptt_off() {
+ error_handler
+ .lock()
+ .unwrap()
+ .soundmodem_error(ErrorSource::Ptt, e);
}
}
ptt = new_ptt;
}
pub trait InputSource: Send + Sync + 'static {
- fn start(&self, samples: SyncSender<SoundmodemEvent>);
+ fn start(&self, samples: SyncSender<SoundmodemEvent>, errors: SoundmodemErrorSender);
fn close(&self);
}
-pub struct InputSoundcard {
- // TODO: allow for inversion both here and in output
- cpal_name: Option<String>,
- 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),
- end_tx: Mutex::new(None),
- }
- }
-}
-
-impl InputSource for InputSoundcard {
- fn start(&self, samples: SyncSender<SoundmodemEvent>) {
- let (end_tx, end_rx) = channel();
- let cpal_name = self.cpal_name.clone();
- 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| {
- 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();
- });
- *self.end_tx.lock().unwrap() = Some(end_tx);
- }
-
- fn close(&self) {
- let _ = self.end_tx.lock().unwrap().take();
- }
-}
-
pub struct InputRrcFile {
- path: PathBuf,
+ baseband: Arc<[u8]>,
end_tx: Mutex<Option<Sender<()>>>,
}
impl InputRrcFile {
- pub fn new(path: PathBuf) -> Self {
- Self {
- path,
+ 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),
- }
+ })
}
}
impl InputSource for InputRrcFile {
- fn start(&self, samples: SyncSender<SoundmodemEvent>) {
+ fn start(&self, samples: SyncSender<SoundmodemEvent>, errors: SoundmodemErrorSender) {
let (end_tx, end_rx) = channel();
- let path = self.path.clone();
+ let baseband = self.baseband.clone();
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;
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:?}");
+ if samples
+ .try_send(SoundmodemEvent::BasebandInput(buf.into()))
+ .is_err()
+ {
+ errors.send_error(InputRrcError::Overflow);
}
- next_tick = next_tick + TICK;
+ next_tick += TICK;
idx = 0;
std::thread::sleep(next_tick.duration_since(Instant::now()));
}
}
}
+#[derive(Debug, Error)]
+pub enum InputRrcError {
+ #[error("overflow occurred feeding sample to soundmodem")]
+ Overflow,
+}
+
pub struct NullInputSource {
end_tx: Mutex<Option<Sender<()>>>,
}
}
impl InputSource for NullInputSource {
- fn start(&self, samples: SyncSender<SoundmodemEvent>) {
+ fn start(&self, samples: SyncSender<SoundmodemEvent>, errors: SoundmodemErrorSender) {
let (end_tx, end_rx) = channel();
std::thread::spawn(move || {
// assuming 48 kHz for 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 let Err(e) = samples.try_send(SoundmodemEvent::BasebandInput(
- [0i16; SAMPLES_PER_TICK].into(),
- )) {
- debug!("overflow feeding soundmodem: {e:?}");
+ if samples
+ .try_send(SoundmodemEvent::BasebandInput(
+ [0i16; SAMPLES_PER_TICK].into(),
+ ))
+ .is_err()
+ {
+ errors.send_error(NullInputError::Overflow);
}
}
});
}
}
+#[derive(Debug, Error)]
+pub enum NullInputError {
+ #[error("overflow occurred feeding sample to soundmodem")]
+ Overflow,
+}
+
+impl Default for NullInputSource {
+ fn default() -> Self {
+ Self::new()
+ }
+}
+
pub struct OutputBuffer {
- idling: bool,
+ pub idling: bool,
// TODO: something more efficient
- samples: VecDeque<i16>,
- latency: Duration,
+ pub samples: VecDeque<i16>,
+ pub latency: Duration,
}
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 start(
+ &self,
+ event_tx: SyncSender<SoundmodemEvent>,
+ buffer: Arc<RwLock<OutputBuffer>>,
+ errors: SoundmodemErrorSender,
+ );
fn close(&self);
}
}
impl OutputSink for OutputRrcFile {
- fn start(&self, event_tx: SyncSender<SoundmodemEvent>, buffer: Arc<RwLock<OutputBuffer>>) {
+ fn start(
+ &self,
+ event_tx: SyncSender<SoundmodemEvent>,
+ buffer: Arc<RwLock<OutputBuffer>>,
+ errors: SoundmodemErrorSender,
+ ) {
let (end_tx, end_rx) = channel();
- let path = self.path.clone();
+ let mut file = match File::create(self.path.clone()) {
+ Ok(f) => f,
+ Err(e) => {
+ errors.send_error(OutputRrcError::Open(e));
+ return;
+ }
+ };
std::thread::spawn(move || {
- // TODO: error handling
- let mut file = File::create(path).unwrap();
-
// assuming 48 kHz for now
const TICK: Duration = Duration::from_millis(25);
const SAMPLES_PER_TICK: usize = 1200;
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;
}
out.copy_from_slice(&[be[0], be[1]]);
buf_used += 2;
} else if !buffer.idling {
- debug!("output rrc file had underrun");
let _ = event_tx.send(SoundmodemEvent::OutputUnderrun);
break;
}
}
if let Err(e) = file.write_all(&buf[0..buf_used]) {
- debug!("failed to write to rrc file: {e:?}");
+ errors.send_error(OutputRrcError::WriteError(e));
break;
}
let _ = event_tx.send(SoundmodemEvent::DidReadFromOutputBuffer {
}
}
+#[derive(Debug, Error)]
+pub enum OutputRrcError {
+ #[error("unable to open rrc file for writing: {0}")]
+ Open(#[source] std::io::Error),
+
+ #[error("error writing to output file: {0}")]
+ WriteError(#[source] std::io::Error),
+}
+
pub struct NullOutputSink {
end_tx: Mutex<Option<Sender<()>>>,
}
}
}
+impl Default for NullOutputSink {
+ fn default() -> Self {
+ Self::new()
+ }
+}
+
impl OutputSink for NullOutputSink {
- fn start(&self, event_tx: SyncSender<SoundmodemEvent>, buffer: Arc<RwLock<OutputBuffer>>) {
+ fn start(
+ &self,
+ event_tx: SyncSender<SoundmodemEvent>,
+ buffer: Arc<RwLock<OutputBuffer>>,
+ _errors: SoundmodemErrorSender,
+ ) {
let (end_tx, end_rx) = channel();
std::thread::spawn(move || {
// assuming 48 kHz for 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();
let mut taken = 0;
for _ in 0..SAMPLES_PER_TICK {
- if !buffer.samples.pop_front().is_some() {
+ if buffer.samples.pop_front().is_none() {
if !buffer.idling {
- debug!("null output had underrun");
let _ = event_tx.send(SoundmodemEvent::OutputUnderrun);
break;
}
}
}
-pub struct OutputSoundcard {
- // TODO: allow for inversion both here and in output
- cpal_name: Option<String>,
- end_tx: Mutex<Option<Sender<()>>>,
+pub trait Ptt: Send + 'static {
+ fn ptt_on(&mut self) -> Result<(), SoundmodemError>;
+ fn ptt_off(&mut self) -> Result<(), SoundmodemError>;
}
-impl OutputSoundcard {
+/// 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 {
- cpal_name: None,
- end_tx: Mutex::new(None),
- }
+ Self
}
+}
- pub fn new_with_card(card_name: String) -> Self {
- Self {
- cpal_name: Some(card_name),
- end_tx: Mutex::new(None),
- }
+impl Default for NullPtt {
+ fn default() -> Self {
+ Self::new()
}
}
-impl OutputSink for OutputSoundcard {
- fn start(&self, event_tx: SyncSender<SoundmodemEvent>, buffer: Arc<RwLock<OutputBuffer>>) {
- let (end_tx, end_rx) = channel();
- let cpal_name = self.cpal_name.clone();
- std::thread::spawn(move || {
- let host = cpal::default_host();
- let device = if let Some(name) = cpal_name.as_deref() {
- host.output_devices()
- .unwrap()
- .find(|d| d.name().unwrap() == name)
- .unwrap()
- } else {
- host.default_output_device().unwrap()
- };
- let mut configs = device.supported_output_configs().unwrap();
- // TODO: more error handling
- let config = configs
- .find(|c| c.channels() == 1 && c.sample_format() == SampleFormat::I16)
- .unwrap()
- .with_sample_rate(SampleRate(48000));
- let stream = device
- .build_output_stream(
- &config.into(),
- move |data: &mut [i16], info: &cpal::OutputCallbackInfo| {
- let mut taken = 0;
- let ts = info.timestamp();
- let latency = ts
- .playback
- .duration_since(&ts.callback)
- .unwrap_or(Duration::ZERO);
- let mut buffer = buffer.write().unwrap();
- buffer.latency = latency;
- for out in data.iter_mut() {
- if let Some(s) = buffer.samples.pop_front() {
- *out = s;
- taken += 1;
- } else if buffer.idling {
- *out = 0;
- } else {
- debug!("output soundcard had underrun");
- let _ = event_tx.send(SoundmodemEvent::OutputUnderrun);
- break;
- }
- }
- //debug!("latency is {} ms, taken {taken}", latency.as_millis());
- let _ = event_tx.send(SoundmodemEvent::DidReadFromOutputBuffer {
- len: taken,
- timestamp: Instant::now(),
- });
- },
- |e| {
- // TODO: abort?
- debug!("error occurred in soundcard output: {e:?}");
- },
- None,
- )
- .unwrap();
- stream.play().unwrap();
- let _ = end_rx.recv();
- });
- *self.end_tx.lock().unwrap() = Some(end_tx);
+impl Ptt for NullPtt {
+ fn ptt_on(&mut self) -> Result<(), SoundmodemError> {
+ Ok(())
}
- fn close(&self) {
- let _ = self.end_tx.lock().unwrap().take();
+ fn ptt_off(&mut self) -> Result<(), SoundmodemError> {
+ Ok(())
}
}
projects / m17rt / blobdiff