rustradio 0.18.0

Software defined radio library
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

/*! Correlate Access Code blocks.

For now an initial yes/no bit block. Future work should add tagging.
*/
use crate::stream::{ReadStream, Tag, TagValue, WriteStream};

/// `CorrelateAccessCode` outputs 1 if CAC matches.
#[derive(rustradio_macros::Block)]
#[rustradio(crate, sync)]
pub struct CorrelateAccessCode {
    #[rustradio(in)]
    src: ReadStream<u8>,
    #[rustradio(out)]
    dst: WriteStream<u8>,

    code: Vec<u8>,
    slide: Vec<u8>,
    allowed_diffs: usize,
}

impl CorrelateAccessCode {
    /// Create new correlate access block.
    #[must_use]
    pub fn new(src: ReadStream<u8>, code: Vec<u8>, allowed_diffs: usize) -> (Self, ReadStream<u8>) {
        assert!(!code.is_empty(), "access code must be nonempty");
        let (dst, dr) = crate::stream::new_stream();
        (
            Self {
                src,
                dst,
                slide: Vec::with_capacity(code.len()),
                code,
                allowed_diffs,
            },
            dr,
        )
    }
    fn process_sync(&mut self, a: u8) -> u8 {
        self.slide.push(a);

        if self.slide.len() > self.code.len() {
            self.slide.remove(0);
        }
        if self.slide.len() < self.code.len() {
            return 0;
        }
        let diffs = self
            .slide
            .iter()
            .zip(&self.code)
            .filter(|(a, b)| a != b)
            .count();
        u8::from(diffs <= self.allowed_diffs)
    }
}

/// `CorrelateAccessCode` outputs 1 if CAC matches.
#[derive(rustradio_macros::Block)]
#[rustradio(crate, sync_tag)]
pub struct CorrelateAccessCodeTag {
    code: Vec<u8>,
    #[rustradio(in)]
    src: ReadStream<u8>,
    #[rustradio(out)]
    dst: WriteStream<u8>,
    slide: Vec<u8>,
    allowed_diffs: usize,
    tag: String,
}

impl CorrelateAccessCodeTag {
    /// Create new correlate access block.
    pub fn new<S: Into<String>>(
        src: ReadStream<u8>,
        code: Vec<u8>,
        tag: S,
        allowed_diffs: usize,
    ) -> (Self, ReadStream<u8>) {
        assert!(!code.is_empty(), "access code must be nonempty");
        let (dst, dr) = crate::stream::new_stream();
        (
            Self {
                src,
                tag: tag.into(),
                dst,
                slide: Vec::with_capacity(code.len()),
                code,
                allowed_diffs,
            },
            dr,
        )
    }
    fn process_sync_tags(&mut self, a: u8, tags: &[Tag]) -> (u8, Vec<Tag>) {
        self.slide.push(a);

        if self.slide.len() > self.code.len() {
            self.slide.remove(0);
        }
        let diffs = self
            .slide
            .iter()
            .zip(&self.code)
            .filter(|(a, b)| a != b)
            .count();
        let mut tags = tags.to_vec();
        if self.slide.len() == self.code.len() && diffs <= self.allowed_diffs {
            tags.push(Tag::new(
                0,
                self.tag.clone(),
                TagValue::U64(
                    diffs
                        .try_into()
                        .expect("can't happen: usize doesn't fit in u64"),
                ),
            ));
        }
        (a, tags)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::Result;
    use crate::block::Block;

    #[test]
    #[should_panic(expected = "access code must be nonempty")]
    fn rejects_empty_code() {
        let _ = CorrelateAccessCode::new(ReadStream::from_slice(&[]), vec![], 0);
    }

    #[test]
    #[should_panic(expected = "access code must be nonempty")]
    fn tagged_rejects_empty_code() {
        let _ = CorrelateAccessCodeTag::new(ReadStream::from_slice(&[]), vec![], "sync", 0);
    }

    #[test]
    fn waits_for_full_code_before_match() -> Result<()> {
        let src = ReadStream::from_slice(&[1]);
        let (mut cac, out) = CorrelateAccessCode::new(src, vec![0, 1], 0);

        cac.work()?;
        let (buf, _) = out.read_buf()?;

        assert_eq!(buf.slice(), &[0]);
        Ok(())
    }

    #[test]
    fn tagged_waits_for_full_code_before_match() -> Result<()> {
        let src = ReadStream::from_slice(&[1]);
        let (mut cac, out) = CorrelateAccessCodeTag::new(src, vec![0, 1], "sync", 0);

        cac.work()?;
        let (_, tags) = out.read_buf()?;

        assert_eq!(tags, &[]);
        Ok(())
    }
}