m17app 0.1.0

M17 digital radio - high level API, integration with sound cards, serial PTT and TCP/IP
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
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
use crate::tnc::{Tnc, TncError};
use log::debug;
use m17core::kiss::MAX_FRAME_LEN;
use m17core::modem::{Demodulator, Modulator, ModulatorAction, SoftDemodulator, SoftModulator};
use m17core::tnc::SoftTnc;
use std::collections::VecDeque;
use std::fs::File;
use std::io::{self, ErrorKind, Read, Write};
use std::path::PathBuf;
use std::sync::mpsc::{channel, sync_channel, Receiver, Sender, SyncSender, TryRecvError};
use std::sync::RwLock;
use std::sync::{Arc, Mutex};
use std::time::{Duration, Instant};

pub struct Soundmodem {
    event_tx: SyncSender<SoundmodemEvent>,
    kiss_out_rx: Arc<Mutex<Receiver<Arc<[u8]>>>>,
    partial_kiss_out: Arc<Mutex<Option<PartialKissOut>>>,
}

impl Soundmodem {
    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);
        spawn_soundmodem_worker(
            event_tx.clone(),
            event_rx,
            kiss_out_tx,
            Box::new(input),
            Box::new(output),
            Box::new(ptt),
        );
        Self {
            event_tx,
            kiss_out_rx: Arc::new(Mutex::new(kiss_out_rx)),
            partial_kiss_out: Arc::new(Mutex::new(None)),
        }
    }
}

struct PartialKissOut {
    output: Arc<[u8]>,
    idx: usize,
}

impl Read for Soundmodem {
    fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
        {
            let mut partial_kiss_out = self.partial_kiss_out.lock().unwrap();
            if let Some(partial) = partial_kiss_out.as_mut() {
                let remaining = partial.output.len() - partial.idx;
                let to_write = remaining.min(buf.len());
                buf[0..to_write]
                    .copy_from_slice(&partial.output[partial.idx..(partial.idx + to_write)]);
                if to_write == remaining {
                    *partial_kiss_out = None;
                } else {
                    partial.idx += to_write;
                }
                return Ok(to_write);
            }
        }
        let output = {
            let rx = self.kiss_out_rx.lock().unwrap();
            rx.recv()
                .map_err(|s| io::Error::new(ErrorKind::Other, format!("{:?}", s)))?
        };
        let to_write = output.len().min(buf.len());
        buf[0..to_write].copy_from_slice(&output[0..to_write]);
        if to_write != output.len() {
            *self.partial_kiss_out.lock().unwrap() = Some(PartialKissOut {
                output,
                idx: to_write,
            })
        }
        Ok(to_write)
    }
}

impl Write for Soundmodem {
    fn write(&mut self, buf: &[u8]) -> std::io::Result<usize> {
        let _ = self.event_tx.try_send(SoundmodemEvent::Kiss(buf.into()));
        Ok(buf.len())
    }

    fn flush(&mut self) -> std::io::Result<()> {
        Ok(())
    }
}

impl Tnc for Soundmodem {
    fn try_clone(&mut self) -> Result<Self, TncError> {
        Ok(Self {
            event_tx: self.event_tx.clone(),
            kiss_out_rx: self.kiss_out_rx.clone(),
            partial_kiss_out: self.partial_kiss_out.clone(),
        })
    }

    fn start(&mut self) -> Result<(), TncError> {
        let _ = self.event_tx.send(SoundmodemEvent::Start);
        Ok(())
    }

    fn close(&mut self) -> Result<(), TncError> {
        let _ = self.event_tx.send(SoundmodemEvent::Close);
        Ok(())
    }
}

pub enum SoundmodemEvent {
    Kiss(Arc<[u8]>),
    BasebandInput(Arc<[i16]>),
    Start,
    Close,
    DidReadFromOutputBuffer { len: usize, timestamp: Instant },
    OutputUnderrun,
}

fn spawn_soundmodem_worker(
    event_tx: SyncSender<SoundmodemEvent>,
    event_rx: Receiver<SoundmodemEvent>,
    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
        let mut demodulator = SoftDemodulator::new();
        let mut modulator = SoftModulator::new();
        let mut tnc = SoftTnc::new();
        let mut buf = [0u8; MAX_FRAME_LEN];
        let out_buffer = Arc::new(RwLock::new(OutputBuffer::new()));
        let mut out_samples = [0i16; 1024];
        let start = Instant::now();
        let mut ptt = false;
        while let Ok(ev) = event_rx.recv() {
            // Update clock on TNC before we do anything
            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 {
                SoundmodemEvent::Kiss(k) => {
                    let _n = tnc.write_kiss(&k);
                    // TODO: what does it mean if we fail to write it all?
                    // Probably we have to read frames for tx first - revisit this during tx
                }
                SoundmodemEvent::BasebandInput(b) => {
                    for sample in &*b {
                        if let Some(frame) = demodulator.demod(*sample) {
                            tnc.handle_frame(frame);
                            loop {
                                let n = tnc.read_kiss(&mut buf);
                                if n > 0 {
                                    let _ = kiss_out_tx.try_send(buf[0..n].into());
                                } else {
                                    break;
                                }
                            }
                        }
                    }
                    tnc.set_data_carrier_detect(demodulator.data_carrier_detect());
                }
                SoundmodemEvent::Start => {
                    input.start(event_tx.clone());
                    output.start(event_tx.clone(), out_buffer.clone());
                }
                SoundmodemEvent::Close => {
                    ptt_driver.ptt_off();
                    break;
                }
                SoundmodemEvent::DidReadFromOutputBuffer { len, timestamp } => {
                    let (occupied, internal_latency) = {
                        let out_buffer = out_buffer.read().unwrap();
                        (out_buffer.samples.len(), out_buffer.latency)
                    };
                    let internal_latency = (internal_latency.as_secs_f32() * 48000.0) as usize;
                    let dynamic_latency =
                        len.saturating_sub((timestamp.elapsed().as_secs_f32() * 48000.0) as usize);
                    modulator.update_output_buffer(
                        occupied,
                        48000,
                        internal_latency + dynamic_latency,
                    );
                }
                SoundmodemEvent::OutputUnderrun => {
                    // TODO: cancel transmission, send empty data frame to host
                }
            }

            // Update PTT state
            let new_ptt = tnc.ptt();
            if new_ptt != ptt {
                if new_ptt {
                    ptt_driver.ptt_on();
                } else {
                    ptt_driver.ptt_off();
                }
            }
            ptt = new_ptt;

            // Let the modulator do what it wants
            while let Some(action) = modulator.run() {
                match action {
                    ModulatorAction::SetIdle(idling) => {
                        out_buffer.write().unwrap().idling = idling;
                    }
                    ModulatorAction::GetNextFrame => {
                        modulator.provide_next_frame(tnc.read_tx_frame());
                    }
                    ModulatorAction::ReadOutput => loop {
                        let n = modulator.read_output_samples(&mut out_samples);
                        if n == 0 {
                            break;
                        }
                        let mut out_buffer = out_buffer.write().unwrap();
                        for s in &out_samples[0..n] {
                            out_buffer.samples.push_back(*s);
                        }
                    },
                    ModulatorAction::TransmissionWillEnd(in_samples) => {
                        tnc.set_tx_end_time(in_samples);
                    }
                }
            }
        }
    });
}

pub trait InputSource: Send + Sync + 'static {
    fn start(&self, samples: SyncSender<SoundmodemEvent>);
    fn close(&self);
}

pub struct InputRrcFile {
    path: PathBuf,
    end_tx: Mutex<Option<Sender<()>>>,
}

impl InputRrcFile {
    pub fn new(path: PathBuf) -> Self {
        Self {
            path,
            end_tx: Mutex::new(None),
        }
    }
}

impl InputSource for InputRrcFile {
    fn start(&self, samples: SyncSender<SoundmodemEvent>) {
        let (end_tx, end_rx) = channel();
        let path = self.path.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;

            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);
    }

    fn close(&self) {
        let _ = self.end_tx.lock().unwrap().take();
    }
}

pub struct NullInputSource {
    end_tx: Mutex<Option<Sender<()>>>,
}

impl NullInputSource {
    pub fn new() -> Self {
        Self {
            end_tx: Mutex::new(None),
        }
    }
}

impl InputSource for NullInputSource {
    fn start(&self, samples: SyncSender<SoundmodemEvent>) {
        let (end_tx, end_rx) = channel();
        std::thread::spawn(move || {
            // 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;

            loop {
                std::thread::sleep(next_tick.duration_since(Instant::now()));
                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:?}");
                }
            }
        });
        *self.end_tx.lock().unwrap() = Some(end_tx);
    }

    fn close(&self) {
        let _ = self.end_tx.lock().unwrap().take();
    }
}

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

pub struct OutputBuffer {
    pub idling: bool,
    // TODO: something more efficient
    pub samples: VecDeque<i16>,
    pub latency: Duration,
}

impl OutputBuffer {
    pub fn new() -> Self {
        Self {
            idling: true,
            samples: VecDeque::new(),
            latency: Duration::ZERO,
        }
    }
}

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 struct OutputRrcFile {
    path: PathBuf,
    end_tx: Mutex<Option<Sender<()>>>,
}

impl OutputRrcFile {
    pub fn new(path: PathBuf) -> Self {
        Self {
            path,
            end_tx: Mutex::new(None),
        }
    }
}

impl OutputSink for OutputRrcFile {
    fn start(&self, event_tx: SyncSender<SoundmodemEvent>, buffer: Arc<RwLock<OutputBuffer>>) {
        let (end_tx, end_rx) = channel();
        let path = self.path.clone();
        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;

            // flattened BE i16s for writing
            let mut buf = [0u8; SAMPLES_PER_TICK * 2];
            let mut next_tick = Instant::now() + TICK;

            loop {
                std::thread::sleep(next_tick.duration_since(Instant::now()));
                next_tick += TICK;
                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 be = s.to_le_bytes();
                        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:?}");
                    break;
                }
                let _ = event_tx.send(SoundmodemEvent::DidReadFromOutputBuffer {
                    len: buf_used / 2,
                    timestamp: Instant::now(),
                });
            }
        });
        *self.end_tx.lock().unwrap() = Some(end_tx);
    }

    fn close(&self) {
        let _ = self.end_tx.lock().unwrap().take();
    }
}

pub struct NullOutputSink {
    end_tx: Mutex<Option<Sender<()>>>,
}

impl NullOutputSink {
    pub fn new() -> Self {
        Self {
            end_tx: Mutex::new(None),
        }
    }
}

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();
        std::thread::spawn(move || {
            // 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;

            loop {
                std::thread::sleep(next_tick.duration_since(Instant::now()));
                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_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);
    }

    fn close(&self) {
        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) {}
}