Module futuresdr::blocks

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.	✅
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?
Fft	Compute an FFT.	✅
Fir	FIR filter and resampler.	✅
Iir	IIR filter.	✅

Misc

Block	Usage	WebAssembly?
ConsoleSink	Log stream data with log::info!.	✅
Head	Copies only a given number of samples and stops.	✅
NullSink	Drops samples.	✅
NullSource	Generates a stream of zeros.	✅
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	Output the same message periodically.	✅

Performance Evaluation

Block	Usage	WebAssembly?	Feature
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 tracepoint for every batch of produced samples.	❌	lttng
lttng:NullSink	Null sink that calls an lttng tracepoint for every batch of received samples.	❌	lttng

I/O

Block	Usage	WebAssembly?
BlobToUdp	Push Blobs into a UDP socket.	❌
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 socket.	❌
[zeromq::SubSource]	Read samples from ZeroMQ socket.	❌

SDR Hardware (requires soapy feature)

Block	Usage	WebAssembly?
SoapySink	Transmit samples with a Soapy SDR device.	❌
SoapySource	Receive samples from a Soapy SDR device.	❌

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?
WasmSdr	Receive samples from web world.	✅
WasmWsSink	Send samples via a WebSocket.	✅
WasmFreq	Push samples to a GUI sink.	✅

Audio (requires audio feature)

Block	Usage	WebAssembly?
AudioSink	Audio sink.	❌
AudioSource	Audio source.	❌
FileSource	Read an audio file and output its samples.	❌
Oscillator	Create tone.	✅
WavSink	Writes samples to a WAV file	❌

Modules

audio

Audio Blocks

Structs

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.

BlobToUdp

Push Blobs into a UDP socket.

Combine

Apply a function to combine two streams into one.

ConsoleSink

Log stream data with log::info!.

Copy

Copy input samples to the output.

CopyRand

Copy input samples to the output, forwarding only a randomly selected number of samples.

CopyRandBuilder

Create a CopyRand block.

Fft

Compute an FFT.

FileSink

Write samples to a file.

FileSourceNon-WebAssembly

Read samples from a file.

Filter

Apply a function, returning an Option to allow filtering samples.

FiniteSource

Repeatedly apply a function to generate samples, using Option values to allow termination.

Fir

FIR filter.

FirBuilder

Create a Fir filter.

Head

Copies only a given number of samples and stops.

Iir

IIR filter.

IirBuilder

Build an Iir filter.

MessageBurst

Output a given number of messages in one burst and terminate.

MessageBurstBuilder

Build a MessageBurst.

MessageCopy

Forward messages.

MessagePipe

Push received messages into a channel.

MessageSink

Black hole for messages.

MessageSource

Output the same message periodically.

MessageSourceBuilderNon-WebAssembly

Repeats a fixed message on an interval

NullSink

Drop samples.

NullSource

Generate a stream of zeroes.

Source

Repeatedly apply a function to generate samples.

Split

Apply a function to split a stream.

TagDebug

Drop samples, printing tags.

TcpSink

Push samples into a TCP socket.

TcpSource

Push samples into a TCP socket.

ThrottleNon-WebAssembly

Limit sample rate.

VectorSink

Store received samples in vector.

VectorSinkBuilder

Build a VectorSink.

VectorSource

Stream samples from vector.

WebsocketSink

Push samples in a WebSocket.

WebsocketSinkBuilder

Build a WebsocketSink.

Enums

FftDirection

Fft direction.

WebsocketSinkMode

Operation mode for WebsocketSink.