rasterwave 0.6.0

High-performance streaming SSTV, radiofax and RTTY encoders/decoders
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
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
use std::collections::VecDeque;
use std::f64::consts::{PI, TAU};

use super::ita2::{self, Encoded, Shift};
use super::profile::{CharacterSet, RttyProfile, RttyTones, validate_sample_rate};
use crate::{Error, Result};

/// What the encoder transmits while its text buffer is empty.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Default)]
#[non_exhaustive]
pub enum RttyIdle {
    /// Repeated LTRS characters ("diddles"), which keep receivers synchronised.
    #[default]
    Diddle,
    /// Continuous mark tone.
    Mark,
}

/// Interactive RTTY encoder options.
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct RttyEncoderConfig {
    /// Signalling profile.
    pub profile: RttyProfile,
    /// Audio tone pair.
    pub tones: RttyTones,
    /// Figures-case variant.
    pub character_set: CharacterSet,
    /// Peak output amplitude in `0.0..=1.0`.
    pub amplitude: f32,
    /// Mark carrier sent before the first character.
    pub preamble_mark_seconds: f64,
    /// LTRS characters sent after the preamble carrier.
    pub preamble_ltrs: u8,
    /// Filler used while no text is waiting.
    pub idle: RttyIdle,
    /// LTRS characters sent after the last character when finishing.
    pub tail_ltrs: u8,
    /// Mark carrier held after the tail characters.
    pub tail_mark_seconds: f64,
    /// Raised-cosine frequency transition at each bit edge.
    pub transition_seconds: f64,
    /// Amplitude ramp applied at the beginning and end of the transmission.
    pub envelope_seconds: f64,
    /// Send `\n` as CR LF.
    pub expand_newline: bool,
}

impl Default for RttyEncoderConfig {
    fn default() -> Self {
        Self {
            profile: RttyProfile::default(),
            tones: RttyTones::default(),
            character_set: CharacterSet::default(),
            amplitude: 0.7,
            preamble_mark_seconds: 0.2,
            preamble_ltrs: 2,
            idle: RttyIdle::Diddle,
            tail_ltrs: 1,
            tail_mark_seconds: 0.1,
            transition_seconds: 0.002,
            envelope_seconds: 0.005,
            expand_newline: true,
        }
    }
}

/// Result of [`RttyEncoder::push_text`].
#[derive(Clone, Debug, Default, PartialEq, Eq)]
pub struct RttyPushReport {
    /// Number of characters accepted into the transmit buffer.
    pub accepted: usize,
    /// Sequence number of the first accepted character, if any. Accepted
    /// characters are numbered consecutively from this value.
    pub first_seq: Option<u64>,
    /// Characters that have no ITA2 representation and were skipped.
    pub rejected: Vec<char>,
}

/// A buffered character that has been committed to the waveform.
///
/// Once reported it can no longer be retracted. Sample positions count from
/// the first sample produced by this encoder.
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub struct RttyCharRendered {
    /// Sequence number assigned by [`RttyEncoder::push_text`].
    pub seq: u64,
    /// Transmitted character after case folding.
    pub ch: char,
    /// First sample of the character's own start bit (of the CR when `\n` is
    /// expanded to CR LF).
    pub start_sample: u64,
    /// Sample after the character's last stop bit.
    pub end_sample: u64,
}

/// Upper bound on buffered, uncommitted characters.
const MAX_PENDING: usize = 4_096;

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
enum Stage {
    Start,
    Running,
    Tail,
    Done,
}

#[derive(Clone, Copy, Debug)]
struct BitSpan {
    mark: bool,
    end_sample: u64,
}

#[derive(Clone, Copy, Debug)]
struct Pending {
    seq: u64,
    ch: char,
    encoded: Encoded,
}

/// Streaming, interactive RTTY AFSK encoder.
///
/// Text can be appended while samples are being read. Characters stay
/// retractable until the waveform generator reaches them, which happens at
/// most one character ahead of the samples already returned. The encoder never
/// ends on its own: it sends idle filler until [`RttyEncoder::finish`] or
/// [`RttyEncoder::abort`] is called.
#[derive(Debug)]
pub struct RttyEncoder {
    config: RttyEncoderConfig,
    sample_rate: u32,
    samples_per_bit: f64,
    transition_samples: f64,
    envelope_samples: f64,
    stage: Stage,
    finish_requested: bool,
    pending: VecDeque<Pending>,
    bits: VecDeque<BitSpan>,
    scheduled_until: f64,
    shift: Option<Shift>,
    last_code: Option<u8>,
    next_seq: u64,
    rendered: Vec<RttyCharRendered>,
    position: u64,
    end_sample: Option<u64>,
    phase: f64,
    target_hz: f64,
    from_hz: f64,
    transition_pos: f64,
}

impl RttyEncoder {
    /// Creates an encoder producing mono `f32` PCM at `sample_rate`.
    pub fn new(sample_rate: u32, config: RttyEncoderConfig) -> Result<Self> {
        validate_sample_rate(sample_rate)?;
        config.profile.validate()?;
        config.tones.validate(sample_rate)?;
        config.profile.check_tones(&config.tones)?;
        if !config.amplitude.is_finite() || !(0.0..=1.0).contains(&config.amplitude) {
            return Err(Error::InvalidConfiguration(
                "RTTY amplitude must be between 0 and 1",
            ));
        }
        for seconds in [
            config.preamble_mark_seconds,
            config.tail_mark_seconds,
            config.transition_seconds,
            config.envelope_seconds,
        ] {
            if !seconds.is_finite() || !(0.0..=10.0).contains(&seconds) {
                return Err(Error::InvalidConfiguration(
                    "RTTY encoder durations must be between 0 and 10 seconds",
                ));
            }
        }
        let rate = f64::from(sample_rate);
        let samples_per_bit = rate / config.profile.baud;
        let transition_samples = (config.transition_seconds * rate).min(samples_per_bit / 2.0);
        Ok(Self {
            config,
            sample_rate,
            samples_per_bit,
            transition_samples,
            envelope_samples: config.envelope_seconds * rate,
            stage: Stage::Start,
            finish_requested: false,
            pending: VecDeque::new(),
            bits: VecDeque::new(),
            scheduled_until: 0.0,
            shift: None,
            last_code: None,
            next_seq: 0,
            rendered: Vec::new(),
            position: 0,
            end_sample: None,
            phase: 0.0,
            target_hz: config.tones.mark_hz,
            from_hz: config.tones.mark_hz,
            transition_pos: f64::INFINITY,
        })
    }

    /// Output sample rate.
    #[must_use]
    pub fn sample_rate(&self) -> u32 {
        self.sample_rate
    }

    /// Appends text to the transmit buffer.
    ///
    /// Lower case is folded to upper case; characters without an ITA2 code, and
    /// characters beyond the buffer limit of 4096, are reported in
    /// [`RttyPushReport::rejected`]. Text may be added after
    /// [`RttyEncoder::finish`] until the tail has started.
    pub fn push_text(&mut self, text: &str) -> Result<RttyPushReport> {
        if matches!(self.stage, Stage::Tail | Stage::Done) || self.end_sample.is_some() {
            return Err(Error::EncoderFinished);
        }
        let mut report = RttyPushReport::default();
        for ch in text.chars() {
            if self.pending.len() >= MAX_PENDING {
                report.rejected.push(ch);
                continue;
            }
            match ita2::encode(ch, self.config.character_set) {
                Some(encoded) => {
                    let seq = self.next_seq;
                    self.next_seq += 1;
                    report.first_seq.get_or_insert(seq);
                    report.accepted += 1;
                    self.pending.push_back(Pending {
                        seq,
                        ch: ch.to_ascii_uppercase(),
                        encoded,
                    });
                }
                None => report.rejected.push(ch),
            }
        }
        Ok(report)
    }

    /// Number of characters still retractable.
    #[must_use]
    pub fn pending_len(&self) -> usize {
        self.pending.len()
    }

    /// Characters still retractable, oldest first.
    #[must_use]
    pub fn pending_text(&self) -> String {
        self.pending.iter().map(|pending| pending.ch).collect()
    }

    /// Removes up to `count` of the most recently pushed, not yet committed characters.
    ///
    /// Returns the number removed.
    pub fn retract_unsent(&mut self, count: usize) -> usize {
        let removed = count.min(self.pending.len());
        self.pending.truncate(self.pending.len() - removed);
        removed
    }

    /// Removes every character that has not been committed. Returns the number removed.
    pub fn clear_unsent(&mut self) -> usize {
        let removed = self.pending.len();
        self.pending.clear();
        removed
    }

    /// Ends the transmission after the buffered text, a short tail and an amplitude ramp.
    pub fn finish(&mut self) {
        self.finish_requested = true;
    }

    /// Stops as soon as possible: buffered text is dropped and the output ramps down.
    ///
    /// A character already reported by [`RttyEncoder::drain_rendered`] may be
    /// cut short; it was sent completely only if its `end_sample` is not after
    /// the final [`RttyEncoder::samples_rendered`]. Aborting during the tail
    /// scheduled by [`RttyEncoder::finish`] cuts the tail short as well.
    pub fn abort(&mut self) {
        self.pending.clear();
        self.finish_requested = true;
        if self.stage == Stage::Done {
            return;
        }
        let ramp = self.envelope_samples.ceil() as u64;
        let end = self.position + ramp;
        if self.end_sample.is_some_and(|scheduled| scheduled <= end) {
            // Already inside the final release ramp.
            return;
        }
        self.end_sample = Some(end);
        if ramp == 0 {
            self.stage = Stage::Done;
        }
    }

    /// True once all samples have been returned.
    #[must_use]
    pub fn is_finished(&self) -> bool {
        self.stage == Stage::Done
    }

    /// True after [`RttyEncoder::finish`] or [`RttyEncoder::abort`] was requested.
    #[must_use]
    pub fn is_finishing(&self) -> bool {
        self.finish_requested
    }

    /// Number of samples returned so far.
    #[must_use]
    pub fn samples_rendered(&self) -> u64 {
        self.position
    }

    /// Moves committed-character reports into `out`.
    ///
    /// Reports accumulate until drained; streaming callers drain after every read.
    pub fn drain_rendered(&mut self, out: &mut Vec<RttyCharRendered>) {
        out.append(&mut self.rendered);
    }

    /// Fills `output` with PCM and returns the number of samples written.
    ///
    /// A short count means the transmission has finished.
    pub fn read_samples(&mut self, output: &mut [f32]) -> usize {
        let rate = f64::from(self.sample_rate);
        let mut written = 0;
        while written < output.len() {
            if self.stage == Stage::Done {
                break;
            }
            if self.end_sample.is_some_and(|end| self.position >= end) {
                self.stage = Stage::Done;
                break;
            }
            let Some(bit) = self.current_bit() else {
                self.stage = Stage::Done;
                break;
            };
            let tone = if bit.mark {
                self.config.tones.mark_hz
            } else {
                self.config.tones.space_hz
            };
            if tone != self.target_hz {
                self.from_hz = self.instantaneous_hz();
                self.target_hz = tone;
                self.transition_pos = 0.0;
            }
            let mut span_end = bit.end_sample;
            if let Some(end) = self.end_sample {
                span_end = span_end.min(end);
            }
            let available = (span_end - self.position) as usize;
            let count = available.min(output.len() - written);
            let amplitude = f64::from(self.config.amplitude);
            for sample in &mut output[written..written + count] {
                let hz = self.instantaneous_hz();
                self.transition_pos += 1.0;
                *sample = (self.phase.sin() * amplitude * self.envelope_at(self.position)) as f32;
                self.phase += TAU * hz / rate;
                if self.phase >= TAU {
                    self.phase -= TAU;
                }
                self.position += 1;
            }
            written += count;
            if self.position >= bit.end_sample {
                self.bits.pop_front();
            }
        }
        written
    }

    fn instantaneous_hz(&self) -> f64 {
        if self.transition_pos >= self.transition_samples {
            return self.target_hz;
        }
        let progress = 0.5 * (1.0 - (PI * self.transition_pos / self.transition_samples).cos());
        self.from_hz + (self.target_hz - self.from_hz) * progress
    }

    fn envelope_at(&self, position: u64) -> f64 {
        if self.envelope_samples <= 0.0 {
            return 1.0;
        }
        let attack = (position as f64 / self.envelope_samples).min(1.0);
        let release = self.end_sample.map_or(1.0, |end| {
            (end.saturating_sub(position) as f64 / self.envelope_samples).min(1.0)
        });
        let level = attack.min(release);
        0.5 * (1.0 - (PI * level).cos())
    }

    fn current_bit(&mut self) -> Option<BitSpan> {
        while self
            .bits
            .front()
            .is_some_and(|bit| bit.end_sample <= self.position)
        {
            self.bits.pop_front();
        }
        if self.bits.is_empty() {
            self.schedule();
        }
        self.bits.front().copied()
    }

    fn schedule(&mut self) {
        if self.end_sample.is_some() {
            // Aborting: hold mark until the release ramp completes.
            self.push_bits(true, 1.0);
            return;
        }
        match self.stage {
            Stage::Start => {
                let preamble_bits = self.config.preamble_mark_seconds * self.config.profile.baud;
                if preamble_bits > 0.0 {
                    self.push_bits(true, preamble_bits);
                }
                for _ in 0..self.config.preamble_ltrs {
                    self.push_code(ita2::LTRS);
                    self.shift = Some(Shift::Letters);
                }
                self.stage = Stage::Running;
                if self.bits.is_empty() {
                    self.schedule();
                }
            }
            Stage::Running => {
                if let Some(next) = self.pending.pop_front() {
                    self.schedule_character(next);
                } else if self.finish_requested {
                    for _ in 0..self.config.tail_ltrs {
                        self.push_code(ita2::LTRS);
                    }
                    let tail_bits = self.config.tail_mark_seconds * self.config.profile.baud;
                    if tail_bits > 0.0 {
                        self.push_bits(true, tail_bits);
                    }
                    let release = self.envelope_samples.ceil() as u64;
                    if release > 0 {
                        self.push_bits(true, release as f64 / self.samples_per_bit);
                    }
                    self.end_sample = Some(self.scheduled_until.round() as u64);
                    self.stage = Stage::Tail;
                } else {
                    match self.config.idle {
                        // Diddle in the current case so slow typing of figures
                        // does not need a FIGS before every character.
                        RttyIdle::Diddle if self.shift == Some(Shift::Figures) => {
                            self.push_code(ita2::FIGS);
                        }
                        RttyIdle::Diddle => {
                            self.push_code(ita2::LTRS);
                            self.shift = Some(Shift::Letters);
                        }
                        RttyIdle::Mark => self.push_bits(true, 1.0),
                    }
                }
            }
            Stage::Tail | Stage::Done => {}
        }
    }

    fn schedule_character(&mut self, next: Pending) {
        let Encoded { code, shift } = next.encoded;
        if let Some(required) = shift.filter(|&required| self.shift != Some(required)) {
            self.push_code(match required {
                Shift::Letters => ita2::LTRS,
                Shift::Figures => ita2::FIGS,
            });
            self.shift = Some(required);
        }
        let start_sample = self.scheduled_until.round() as u64;
        if next.ch == '\n' && self.config.expand_newline && self.last_code != Some(ita2::CR) {
            self.push_code(ita2::CR);
        }
        self.push_code(code);
        if code == ita2::SPACE && self.shift == Some(Shift::Figures) {
            // A receiver with unshift-on-space is now in letters; one without is not.
            self.shift = None;
        }
        self.rendered.push(RttyCharRendered {
            seq: next.seq,
            ch: next.ch,
            start_sample,
            end_sample: self.scheduled_until.round() as u64,
        });
    }

    fn push_code(&mut self, code: u8) {
        self.last_code = Some(code);
        self.push_bits(false, 1.0);
        for bit in 0..5 {
            self.push_bits((code >> bit) & 1 == 1, 1.0);
        }
        self.push_bits(true, self.config.profile.stop_bits.bits());
    }

    fn push_bits(&mut self, mark: bool, bits: f64) {
        self.scheduled_until += bits * self.samples_per_bit;
        let end_sample = self.scheduled_until.round() as u64;
        if let Some(last) = self.bits.back_mut().filter(|last| last.mark == mark) {
            last.end_sample = end_sample;
            return;
        }
        self.bits.push_back(BitSpan { mark, end_sample });
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    fn read_all(encoder: &mut RttyEncoder, chunk: usize) -> Vec<f32> {
        let mut out = Vec::new();
        let mut buffer = vec![0.0; chunk];
        while !encoder.is_finished() {
            let n = encoder.read_samples(&mut buffer);
            out.extend_from_slice(&buffer[..n]);
            assert!(out.len() < 10_000_000, "encoder did not finish");
        }
        out
    }

    #[test]
    fn finished_transmission_has_expected_length() {
        let config = RttyEncoderConfig {
            preamble_mark_seconds: 0.0,
            preamble_ltrs: 0,
            tail_ltrs: 0,
            tail_mark_seconds: 0.0,
            envelope_seconds: 0.0,
            ..RttyEncoderConfig::default()
        };
        let mut encoder = RttyEncoder::new(12_000, config).unwrap();
        encoder.push_text("RY").unwrap();
        encoder.finish();
        let pcm = read_all(&mut encoder, 333);
        // The shift is unknown at the start, so LTRS precedes the first letter.
        let expected = 3.0 * 7.5 * 12_000.0 / 45.45;
        assert!((pcm.len() as f64 - expected).abs() <= 1.0, "{}", pcm.len());
        let mut rendered = Vec::new();
        encoder.drain_rendered(&mut rendered);
        assert_eq!(rendered.len(), 2);
        assert_eq!(rendered[0].ch, 'R');
        assert_eq!(rendered[1].start_sample, rendered[0].end_sample);
    }

    #[test]
    fn idle_never_finishes_and_retract_removes_uncommitted_text() {
        let mut encoder = RttyEncoder::new(12_000, RttyEncoderConfig::default()).unwrap();
        let mut buffer = vec![0.0; 1024];
        assert_eq!(encoder.read_samples(&mut buffer), 1024);
        let report = encoder.push_text("CQ test%").unwrap();
        assert_eq!(report.accepted, 7);
        assert_eq!(report.rejected, vec!['%']);
        assert_eq!(encoder.retract_unsent(3), 3);
        assert_eq!(encoder.pending_len(), 4);
        for _ in 0..200 {
            assert_eq!(encoder.read_samples(&mut buffer), 1024);
        }
        let mut rendered = Vec::new();
        encoder.drain_rendered(&mut rendered);
        let text: String = rendered.iter().map(|r| r.ch).collect();
        assert_eq!(text, "CQ T");
        assert!(!encoder.is_finished());
    }

    #[test]
    fn abort_ramps_down_quickly() {
        let mut encoder = RttyEncoder::new(48_000, RttyEncoderConfig::default()).unwrap();
        encoder.push_text("RYRYRYRYRY").unwrap();
        let mut buffer = vec![0.0; 4800];
        encoder.read_samples(&mut buffer);
        encoder.abort();
        let rest = read_all(&mut encoder, 4800);
        assert!(rest.len() <= 241, "{}", rest.len());
        assert!(encoder.is_finished());
        assert!(encoder.push_text("X").is_err());
    }

    #[test]
    fn abort_during_the_finish_tail_ramps_down_quickly() {
        let config = RttyEncoderConfig {
            tail_mark_seconds: 5.0,
            ..RttyEncoderConfig::default()
        };
        let mut encoder = RttyEncoder::new(12_000, config).unwrap();
        encoder.push_text("CQ").unwrap();
        encoder.finish();
        let mut buffer = vec![0.0; 1200];
        for _ in 0..20 {
            assert_eq!(encoder.read_samples(&mut buffer), 1200);
        }
        assert!(encoder.pending_len() == 0 && !encoder.is_finished());
        encoder.abort();
        let rest = read_all(&mut encoder, 1200);
        // Default 5 ms ramp at 12 kHz.
        assert!(rest.len() <= 61, "{}", rest.len());
        assert!(encoder.is_finished());
        // Aborting inside the release ramp keeps it.
        let mut encoder = RttyEncoder::new(12_000, RttyEncoderConfig::default()).unwrap();
        encoder.push_text("CQ").unwrap();
        encoder.abort();
        let mut short = vec![0.0; 30];
        assert_eq!(encoder.read_samples(&mut short), 30);
        encoder.abort();
        assert_eq!(read_all(&mut encoder, 1200).len(), 30);
    }

    #[test]
    fn output_is_chunk_size_invariant() {
        let make = |chunk| {
            let mut encoder = RttyEncoder::new(12_000, RttyEncoderConfig::default()).unwrap();
            encoder.push_text("CQ CQ DE BG5DRB 599 73\n").unwrap();
            encoder.finish();
            read_all(&mut encoder, chunk)
        };
        let reference = make(4096);
        for chunk in [1, 7, 127, 1000] {
            assert_eq!(make(chunk), reference);
        }
    }
}