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
//! ## Block Library
//! ## Functional/Apply-style Blocks
//! | Block | Usage | WebAssembly? |
//! |---|---|---|
//! | [Apply] | Apply a function to each sample. | ✅ |
//! | [ApplyIntoIter] | Apply a function on each input sample to create an iterator and output its values. | ✅ |
//! | [ApplyNM] | Apply a function to each N input samples, producing M output samples. | ✅ |
//! | [Combine] | Apply a function to combine two streams into one. | ✅ |
//! | [Filter] | Apply a function, returning an [Option] to allow filtering samples. | ✅ |
//! | [Sink] | Apply a function to received samples. | ✅ |
//! | [Source] | Repeatedly apply a function to generate samples. | ✅ |
//! | [Split] | Apply a function to split a stream. | ✅ |
//! | [FiniteSource] | Repeatedly apply a function to generate samples, using [Option] values to allow termination. | ✅ |
//!
//! ## DSP blocks
//! | Block | Usage | WebAssembly? |
//! |---|---|---|
//! | [Agc](Agc) | Automatic Gain Control | ✅ |
//! | [Fft](Fft) | Compute an FFT. | ✅ |
//! | [Fir](FirBuilder) | FIR filter and resampler. | ✅ |
//! | [Iir](IirBuilder) | IIR filter. | ✅ |
//!
//! ## Misc
//! | Block | Usage | WebAssembly? |
//! |---|---|---|
//! | [ConsoleSink] | Log stream data with [log::info!]. | ✅ |
//! | [Delay] | Delays samples. | ✅ |
//! | [Head] | Copies only a given number of samples and stops. | ✅ |
//! | [NullSink] | Drops samples. | ✅ |
//! | [NullSource] | Generates a stream of zeros. | ✅ |
//! | [Selector] | Forward the input stream with a given index to the output stream with a given index. | ✅ |
//! | [TagDebug] | Drop samples, printing tags. | ✅ |
//! | [Throttle] | Limit sample rate. | ❌ |
//! | [VectorSink] | Store received samples in vector. | ✅ |
//! | [VectorSource] | Stream samples from vector. | ✅ |
//!
//! ## Message Passing
//! | Block | Usage | WebAssembly? |
//! |---|---|---|
//! | [MessageBurst] | Output a given number of messages in one burst and terminate. | ✅ |
//! | [MessageCopy] | Forward messages. | ✅ |
//! | [MessagePipe] | Push received messages into a channel. | ✅ |
//! | [MessageSink] | Black hole for messages. | ✅ |
//! | [MessageSource](MessageSourceBuilder) | Output the same message periodically. | ✅ |
//!
//! ## Performance Evaluation
//! | Block | Usage | WebAssembly? | Feature |
//! |---|---|---|---|
//! | [struct@Copy] | Copy input samples to the output. | ✅ | |
//! | [CopyRand] | Copy input samples to the output, forwarding only a randomly selected number of samples. | ❌ | |
//! | lttng::NullSource | Null source that calls an [lttng](https://lttng.org/) tracepoint for every batch of produced samples. | ❌ | lttng |
//! | lttng:NullSink | Null sink that calls an [lttng](https://lttng.org/) tracepoint for every batch of received samples. | ❌ | lttng |
//!
//! ## I/O
//! | Block | Usage | WebAssembly? |
//! |---|---|---|
//! | [BlobToUdp] | Push [Blobs](crate::runtime::Pmt::Blob) into a UDP socket. | ❌ |
//! | [ChannelSource] | Push samples through a channel into a stream connection. | ✅ |
//! | [FileSink] | Write samples to a file. | ❌ |
//! | [FileSource] | Read samples from a file. | ❌ |
//! | [TcpSource] | Reads samples from a TCP socket. | ❌ |
//! | [TcpSink] | Push samples into a TCP socket. | ❌ |
//! | [WebsocketSink] | Push samples in a WebSocket. | ❌ |
//! | [zeromq::PubSink] | Push samples into [ZeroMQ](https://zeromq.org/) socket. | ❌ |
//! | [zeromq::SubSource] | Read samples from [ZeroMQ](https://zeromq.org/) socket. | ❌ |
//!
//! ## SDR Hardware
//! | Block | Usage | Feature | WebAssembly? |
//! |---|---|---|---|
//! | [SeifySink](seify::SinkBuilder) | Transmit samples with a Seify device. | seify | ❌ |
//! | [SeifySource](seify::SourceBuilder) | Receive samples from a Seify device. | seify | ❌ |
//!
//! ## Hardware Acceleration
//! | Block | Usage | WebAssembly? | Feature |
//! |---|---|---|---|
//! | [Vulkan] | Interface GPU w/ Vulkan. | ❌ | `vulkan` |
//! | [Wgpu] | Interface GPU w/ native API. | ✅ | `wgpu` |
//! | [Zynq] | Interface Zynq FPGA w/ AXI DMA (async mode). | ❌ | `zynq` |
//! | [ZynqSync] | Interface Zynq FPGA w/ AXI DMA (sync mode). | ❌ | `zynq` |
//!
//! ## WASM-specific (target `wasm32-unknown-unknown`)
//! | Block | Usage | WebAssembly? |
//! |---|---|---|
//! | HackRf | WASM + WebUSB source for HackRF. | ✅ |
//! | WasmWsSink | Send samples via a WebSocket. | ✅ |
//!
//! ## Signal Sources
//! | Block | Usage | WebAssembly? |
//! |---|---|---|
//! | [SignalSource](SignalSourceBuilder) | Create signals (sin, cos, square). | ✅ |
//!
//! ## Audio (requires `audio` feature)
//! | Block | Usage | WebAssembly? |
//! |---|---|---|
//! | [AudioSink](audio::AudioSink) | Audio sink. | ❌ |
//! | [AudioSource](audio::AudioSource) | Audio source. | ❌ |
//! | [FileSource](audio::FileSource) | Read an audio file and output its samples. | ❌ |
//! | [WavSink](audio::WavSink) | Writes samples to a WAV file | ❌ |
//!
mod agc;
pub use agc::{Agc, AgcBuilder};
mod apply;
pub use apply::Apply;
mod applynm;
pub use applynm::ApplyNM;
mod applyintoiter;
pub use applyintoiter::ApplyIntoIter;
pub mod audio;
#[cfg(not(target_arch = "wasm32"))]
mod blob_to_udp;
#[cfg(not(target_arch = "wasm32"))]
pub use blob_to_udp::BlobToUdp;
mod combine;
pub use combine::Combine;
mod console_sink;
pub use console_sink::ConsoleSink;
mod copy;
pub use copy::Copy;
mod copy_rand;
pub use copy_rand::{CopyRand, CopyRandBuilder};
mod delay;
pub use delay::Delay;
mod filter;
pub use filter::Filter;
mod fir;
pub use fir::Fir;
pub use fir::FirBuilder;
mod fft;
pub use fft::Fft;
pub use fft::FftDirection;
#[cfg(not(target_arch = "wasm32"))]
mod file_sink;
#[cfg(not(target_arch = "wasm32"))]
pub use file_sink::FileSink;
#[cfg(not(target_arch = "wasm32"))]
mod file_source;
#[cfg(not(target_arch = "wasm32"))]
pub use file_source::FileSource;
mod finite_source;
pub use finite_source::FiniteSource;
mod head;
pub use head::Head;
mod iir;
pub use iir::{Iir, IirBuilder};
#[cfg(feature = "lttng")]
pub mod lttng;
mod message_burst;
pub use message_burst::MessageBurst;
mod message_copy;
pub use message_copy::MessageCopy;
mod message_pipe;
pub use message_pipe::MessagePipe;
mod message_sink;
pub use message_sink::MessageSink;
#[cfg(not(target_arch = "wasm32"))]
mod message_source;
#[cfg(not(target_arch = "wasm32"))]
pub use message_source::{MessageSource, MessageSourceBuilder};
mod null_sink;
pub use null_sink::NullSink;
mod null_source;
pub use null_source::NullSource;
/// Seify hardware driver blocks
#[cfg(feature = "seify")]
pub mod seify;
mod selector;
pub use selector::DropPolicy as SelectorDropPolicy;
pub use selector::Selector;
pub mod signal_source;
pub use signal_source::FixedPointPhase;
pub use signal_source::SignalSourceBuilder;
mod sink;
pub use sink::Sink;
mod source;
pub use source::Source;
mod split;
pub use split::Split;
mod tag_debug;
pub use tag_debug::TagDebug;
#[cfg(not(target_arch = "wasm32"))]
mod tcp_sink;
#[cfg(not(target_arch = "wasm32"))]
pub use tcp_sink::TcpSink;
#[cfg(not(target_arch = "wasm32"))]
mod tcp_source;
#[cfg(not(target_arch = "wasm32"))]
pub use tcp_source::TcpSource;
#[cfg(not(target_arch = "wasm32"))]
mod throttle;
#[cfg(not(target_arch = "wasm32"))]
pub use throttle::Throttle;
mod channel_source;
pub use channel_source::ChannelSource;
mod vector_sink;
pub use vector_sink::{VectorSink, VectorSinkBuilder};
mod vector_source;
pub use vector_source::VectorSource;
#[cfg(feature = "vulkan")]
mod vulkan;
#[cfg(feature = "vulkan")]
pub use vulkan::{Vulkan, VulkanBuilder};
/// WASM-specfici blocks (target wasm32-unknown-unknown)
#[cfg(target_arch = "wasm32")]
pub mod wasm;
#[cfg(not(target_arch = "wasm32"))]
mod websocket_sink;
#[cfg(not(target_arch = "wasm32"))]
pub use websocket_sink::{WebsocketSink, WebsocketSinkBuilder, WebsocketSinkMode};
#[cfg(feature = "wgpu")]
mod wgpu;
#[cfg(feature = "wgpu")]
pub use self::wgpu::Wgpu;
#[cfg(feature = "zeromq")]
pub mod zeromq;
#[cfg(feature = "zynq")]
mod zynq;
#[cfg(feature = "zynq")]
pub use zynq::Zynq;
#[cfg(feature = "zynq")]
mod zynq_sync;
#[cfg(feature = "zynq")]
pub use zynq_sync::ZynqSync;