rustradio 0.16.5

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

/*! Vector to stream block.

Turn stream of e.g. `Vec<u8>` to stream of `u8`.
 */
use log::trace;

use crate::block::{Block, BlockRet};
use crate::stream::{NCReadStream, Tag, TagValue, WriteStream};
use crate::{Result, Sample};

/// This tag gets added to the first output sample of a vec.
///
/// The value is the number of samples in the vector.
pub const TAG_START: &str = "VecToStream::start";

/// This tag gets added to the last output sample of a vec.
///
/// The value is the number of samples in the vector.
pub const TAG_END: &str = "VecToStream::end";

/// Block for vector to stream.
///
/// The output stream is tagged with `VecToStream::start` and `VecToStream::end`
/// on the first and last sample of the stream. For a one-sample vector, these
/// tags will be on the same sample.
///
/// Empty vectors are silently discarded.
#[derive(rustradio_macros::Block)]
#[rustradio(crate, new)]
pub struct VecToStream<T: Sample> {
    #[rustradio(in)]
    src: NCReadStream<Vec<T>>,
    #[rustradio(out)]
    dst: WriteStream<T>,
}

impl<T: Sample> Block for VecToStream<T> {
    fn work(&mut self) -> Result<BlockRet<'_>> {
        let Some(n) = self.src.peek_size() else {
            return Ok(BlockRet::WaitForStream(&self.src, 1));
        };
        let mut o = self.dst.write_buf()?;
        if n > o.len() {
            return Ok(BlockRet::WaitForStream(&self.src, n));
        }
        let (v, mut tags) = self
            .src
            .pop()
            .expect("we just checked the size. It must exist");
        debug_assert_eq!(v.len(), n);
        if n == 0 {
            trace!("VecToStream: discarded empty vector");
            return Ok(BlockRet::Again);
        }
        o.fill_from_iter(v);
        tags.extend([
            Tag::new(0, TAG_START, TagValue::U64(n as u64)),
            Tag::new(n - 1, TAG_END, TagValue::U64(n as u64)),
        ]);
        o.produce(n, &tags);
        Ok(BlockRet::Again)
    }
}

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

    #[test]
    fn empty_input() -> Result<()> {
        let (_tx, rx) = new_nocopy_stream();
        let (mut b, out) = VecToStream::<u8>::new(rx);
        assert!(matches![b.work()?, BlockRet::WaitForStream(_, 1)]);
        assert_eq!(out.read_buf()?.0.len(), 0);
        Ok(())
    }

    #[test]
    fn empty_vec() -> Result<()> {
        let (tx, rx) = new_nocopy_stream();
        tx.push(vec![], &[]);
        let (mut b, out) = VecToStream::<u8>::new(rx);
        assert!(matches![b.work()?, BlockRet::Again]);
        assert!(matches![b.work()?, BlockRet::WaitForStream(_, 1)]);
        assert_eq!(out.read_buf()?.0.len(), 0);
        Ok(())
    }

    #[test]
    fn two() -> Result<()> {
        let (tx, rx) = new_nocopy_stream();
        tx.push(vec![11, 22, 33], &[]);
        tx.push(vec![3, 2, 1, 0], &[]);
        let (mut b, out) = VecToStream::<u8>::new(rx);
        assert!(matches![b.work()?, BlockRet::Again]);
        assert_eq!(out.read_buf()?.0.len(), 3);
        assert!(matches![b.work()?, BlockRet::Again]);
        assert_eq!(out.read_buf()?.0.len(), 7);
        assert!(matches![b.work()?, BlockRet::WaitForStream(_, 1)]);
        let (o, tags) = out.read_buf()?;
        assert_eq!(o.len(), 7);
        assert_eq!(
            tags,
            &[
                Tag::new(0, "VecToStream::start", TagValue::U64(3)),
                Tag::new(2, "VecToStream::end", TagValue::U64(3)),
                Tag::new(3, "VecToStream::start", TagValue::U64(4)),
                Tag::new(6, "VecToStream::end", TagValue::U64(4)),
            ]
        );
        Ok(())
    }
}