satdump::ndsp::Block Class Reference

Base Block class. More...

#include <block.h>

Inheritance diagram for satdump::ndsp::Block:

Public Types
enum	cfg_res_t { RES_OK = 0 , RES_LISTUPD = 1 , RES_IOUPD = 2 , RES_ERR = 3 }
	set_cfg status. More...

Public Member Functions
virtual std::vector< BlockIO >	get_inputs ()
	Get the block's input configurations and streams. You should not modify them.
virtual std::vector< BlockIO >	get_outputs ()
	Get the block's output configurations and streams. You should not modify them.
virtual void	set_input (BlockIO f, int i)
	Link an input to an output stream of some sort. This also checks the type of the BlockIO to ensure (some level of) compatibility.
virtual BlockIO	get_output (int i, int nbuf)
	Get one of the block's outputs, creating the fifo it if nbuf != 0.
void	link (Block *ptr, int output_index, int input_index, int nbuf)
	Link a block's output to another input, more or less just a warper around set_input and set_output.
	Block (std::string id, std::vector< BlockIO > in={}, std::vector< BlockIO > out={})
	Generic constructor, to be overloaded.
virtual bool	is_async ()
	Returns true if a block is async. An async block is a block that has outputs without inputs or inputs that won't directly affect/stop the outputs' behavior. This includes sources (eg, a SDR Device), TXing and RXing at the same time, and anything with similar requirements.
virtual nlohmann::ordered_json	get_cfg_list ()
	Get parameters LIST of the block's parameters. This does not contain actual values, only a description of what is available. This will contains a name, optionally description, its type and range if applicable, string options and so on. This must be re-pulled in several cases :
virtual nlohmann::json	get_cfg (std::string key)=0
	Get parameters of the block as JSON.
nlohmann::json	get_cfg ()
	Get parameters of the block as JSON. Unlike get_cfg(key), this returns every single available parameter as declared by get_cfg_list().
virtual cfg_res_t	set_cfg (std::string key, nlohmann::json v)=0
	Set parameters of the block from JSON, including potentially IO configurations for blocks that may have variable output sizes. However, you likely should implemenet that in a separate function as well (eg, addVFO or such) for it to be easy to be done in C++ directly, and using said function here. Optionally, this can also be made to be functional while the block is running!
cfg_res_t	set_cfg (nlohmann::json v)
	Set parameters of the block from JSON. Essentially the same as set_cfg(key, v), except this will set any number of them at once.
virtual void	start ()
	Starts this block's internal thread and loop.
virtual void	stop (bool stop_now=false, bool force=false)
	Stops the block, or rather tells the internal loop it should exit & joins the thread to wait. TODOREWORK, potentially allow sending the terminator as well to force-quit.

Public Attributes
const std::string	d_id

Protected Member Functions
virtual bool	work ()=0
	The actual looping work function meant to handle all the DSP (well, in most blocks)
bool	is_work_running ()
template<typename T>
void	setValFromJSONIfExists (T &v, nlohmann::json p)
virtual void	init ()
	Applies current parameters to the block. This is called automatically once in start(), but may also be called manually by the block as needed.

Protected Attributes
std::vector< BlockIO >	inputs
std::vector< BlockIO >	outputs
bool	work_should_exit
	Used to signal to a block it should exit in order to stop(). Usually only needed in sources.

Detailed Description

Base Block class.

This has several goals :

• First this simply provides an easy-to-use base to implement most DSP blocks, with inputs/outputs passing pointers around, as well as an internal thread to run the actual loop,
• Secondly, unlike the previous system this class' interface alone is meant to be enough to perform ALL block functions, from configurations to starting/stopping and so on, as well as entirely abstracting types used in IO streams.

See each function's documentation for more information!

Parameters

d_id	the block's ID
inputs	the block's inputs
outputs	the block's outputs

Member Enumeration Documentation

cfg_res_t

enum satdump::ndsp::Block::cfg_res_t

set_cfg status.

Parameters

RES_OK	Applied fine
RES_LISTUPD	get_cfg_list must be pulled again
RES_IOUPD	IO Configuration changed (must ALSO re-pull get_cfg_list!!!)
RES_ERR	Config option not applied

Constructor & Destructor Documentation

Block()

satdump::ndsp::Block::Block ( std::string id, std::vector< BlockIO > in = {}, std::vector< BlockIO > out = {} )

inline

Generic constructor, to be overloaded.

Parameters

id	of the block, meant to be a short identifier (eg, agc_cc)
in	Inputs configurations, optional
out	Output configurations, optional

Member Function Documentation

get_cfg() [1/2]

nlohmann::json satdump::ndsp::Block::get_cfg ( )

inline

Get parameters of the block as JSON. Unlike get_cfg(key), this returns every single available parameter as declared by get_cfg_list().

Returns

All parameters values

get_cfg() [2/2]

virtual nlohmann::json satdump::ndsp::Block::get_cfg ( std::string key )

pure virtual

Get parameters of the block as JSON.

Parameters

key	the parameter to retrieve

Returns

requested parameter value

Implemented in satdump::ndsp::AddBlock< T >, satdump::ndsp::AGCBlock< T >, satdump::ndsp::AGCBlock< complex_t >, satdump::ndsp::BlankerBlock< T >, satdump::ndsp::BlkAGCBlock< T >, satdump::ndsp::ChannelModelSimpleBlock, satdump::ndsp::CharToFloatBlock, satdump::ndsp::ComplexToFloatBlock, satdump::ndsp::ComplexToIFloatBlock, satdump::ndsp::ComplexToImagBlock, satdump::ndsp::ComplexToMagBlock, satdump::ndsp::ComplexToMagSquaredBlock, satdump::ndsp::ComplexToRealBlock, satdump::ndsp::ConstellationDisplayBlock, satdump::ndsp::CorrectIQBlock< T >, satdump::ndsp::CostasBlock, satdump::ndsp::CyclostationaryAnalysis, satdump::ndsp::DelayOneImagBlock, satdump::ndsp::ExponentiateBlock, satdump::ndsp::FFTPanBlock, satdump::ndsp::FileSinkBlock< T >, satdump::ndsp::FileSourceBlock< T >, satdump::ndsp::FIRBlock< T >, satdump::ndsp::FIRBlock< complex_t >, satdump::ndsp::FloatToCharBlock, satdump::ndsp::FloatToComplexBlock, satdump::ndsp::FreqShiftBlock, satdump::ndsp::HilbertBlock, satdump::ndsp::HistogramDisplayBlock, satdump::ndsp::IFloatToComplexBlock, satdump::ndsp::IQSinkBlock, satdump::ndsp::IQSourceBlock, satdump::ndsp::MMClockRecoveryBlock< T >, satdump::ndsp::MMClockRecoveryBlock< complex_t >, satdump::ndsp::MMClockRecoveryFastBlock< T >, satdump::ndsp::MultiplyBlock< T >, satdump::ndsp::NNGIQSinkBlock, satdump::ndsp::PLLCarrierTrackingBlock, satdump::ndsp::PSKDemodHierBlock, satdump::ndsp::QuadratureDemodBlock, satdump::ndsp::RationalResamplerBlock< T >, satdump::ndsp::RealToComplexBlock, satdump::ndsp::RRC_FIRBlock< T >, satdump::ndsp::RRC_FIRBlock< complex_t >, satdump::ndsp::SamplerateMeterBlock< T >, satdump::ndsp::ShortToFloatBlock, satdump::ndsp::SplitterBlock< T >, satdump::ndsp::SubtractBlock< T >, satdump::ndsp::ThrottleBlock< T >, satdump::ndsp::UCharToFloatBlock, satdump::ndsp::VCOBlock, and satdump::ndsp::WaveformBlock< T >.

get_cfg_list()

virtual nlohmann::ordered_json satdump::ndsp::Block::get_cfg_list ( )

inlinevirtual

Get parameters LIST of the block's parameters. This does not contain actual values, only a description of what is available. This will contains a name, optionally description, its type and range if applicable, string options and so on. This must be re-pulled in several cases :

• If set_cfg returns RES_LISTUPD or higher
• If the block is started
• If the block is stopped

Returns

parameters description

Reimplemented in satdump::ndsp::AddBlock< T >, satdump::ndsp::AGCBlock< T >, satdump::ndsp::AGCBlock< complex_t >, satdump::ndsp::BlankerBlock< T >, satdump::ndsp::BlkAGCBlock< T >, satdump::ndsp::ChannelModelSimpleBlock, satdump::ndsp::CharToFloatBlock, satdump::ndsp::ComplexToFloatBlock, satdump::ndsp::ComplexToIFloatBlock, satdump::ndsp::ComplexToMagBlock, satdump::ndsp::ComplexToMagSquaredBlock, satdump::ndsp::CostasBlock, satdump::ndsp::ExponentiateBlock, satdump::ndsp::FileSinkBlock< T >, satdump::ndsp::FileSourceBlock< T >, satdump::ndsp::FloatToCharBlock, satdump::ndsp::FloatToComplexBlock, satdump::ndsp::FreqShiftBlock, satdump::ndsp::HilbertBlock, satdump::ndsp::IFloatToComplexBlock, satdump::ndsp::IQSinkBlock, satdump::ndsp::IQSourceBlock, satdump::ndsp::MMClockRecoveryBlock< T >, satdump::ndsp::MMClockRecoveryBlock< complex_t >, satdump::ndsp::MMClockRecoveryFastBlock< T >, satdump::ndsp::MultiplyBlock< T >, satdump::ndsp::NNGIQSinkBlock, satdump::ndsp::PLLCarrierTrackingBlock, satdump::ndsp::PSKDemodHierBlock, satdump::ndsp::QuadratureDemodBlock, satdump::ndsp::RationalResamplerBlock< T >, satdump::ndsp::RRC_FIRBlock< T >, satdump::ndsp::RRC_FIRBlock< complex_t >, satdump::ndsp::SamplerateMeterBlock< T >, satdump::ndsp::ShortToFloatBlock, satdump::ndsp::SplitterBlock< T >, satdump::ndsp::SubtractBlock< T >, satdump::ndsp::ThrottleBlock< T >, satdump::ndsp::UCharToFloatBlock, satdump::ndsp::VCOBlock, and satdump::ndsp::WaveformBlock< T >.

get_inputs()

virtual std::vector< BlockIO > satdump::ndsp::Block::get_inputs ( )

inlinevirtual

Get the block's input configurations and streams. You should not modify them.

Returns

The block's input BlockIOs.

Reimplemented in satdump::ndsp::PSKDemodHierBlock.

get_output()

virtual BlockIO satdump::ndsp::Block::get_output ( int i, int nbuf )

inlinevirtual

Get one of the block's outputs, creating the fifo it if nbuf != 0.

Parameters

i	index of the output
nbuf	of buffers to setup in the output

Returns

BlockIO struct of the output

Reimplemented in satdump::ndsp::PSKDemodHierBlock.

get_outputs()

virtual std::vector< BlockIO > satdump::ndsp::Block::get_outputs ( )

inlinevirtual

Get the block's output configurations and streams. You should not modify them.

Returns

The block's output BlockIOs.

Reimplemented in satdump::ndsp::PSKDemodHierBlock.

init()

virtual void satdump::ndsp::Block::init ( )

inlineprotectedvirtual

Applies current parameters to the block. This is called automatically once in start(), but may also be called manually by the block as needed.

Reimplemented in satdump::ndsp::AddBlock< T >, satdump::ndsp::AGCBlock< T >, satdump::ndsp::AGCBlock< complex_t >, satdump::ndsp::BlankerBlock< T >, satdump::ndsp::BlkAGCBlock< T >, satdump::ndsp::ChannelModelSimpleBlock, satdump::ndsp::CharToFloatBlock, satdump::ndsp::ComplexToFloatBlock, satdump::ndsp::ComplexToIFloatBlock, satdump::ndsp::ComplexToImagBlock, satdump::ndsp::ComplexToMagBlock, satdump::ndsp::ComplexToMagSquaredBlock, satdump::ndsp::ComplexToRealBlock, satdump::ndsp::CorrectIQBlock< T >, satdump::ndsp::CostasBlock, satdump::ndsp::CyclostationaryAnalysis, satdump::ndsp::DelayOneImagBlock, satdump::ndsp::ExponentiateBlock, satdump::ndsp::FileSinkBlock< T >, satdump::ndsp::FileSourceBlock< T >, satdump::ndsp::FIRBlock< T >, satdump::ndsp::FIRBlock< complex_t >, satdump::ndsp::FloatToCharBlock, satdump::ndsp::FloatToComplexBlock, satdump::ndsp::FreqShiftBlock, satdump::ndsp::HilbertBlock, satdump::ndsp::IFloatToComplexBlock, satdump::ndsp::IQSinkBlock, satdump::ndsp::IQSourceBlock, satdump::ndsp::MMClockRecoveryBlock< T >, satdump::ndsp::MMClockRecoveryBlock< complex_t >, satdump::ndsp::MMClockRecoveryFastBlock< T >, satdump::ndsp::MultiplyBlock< T >, satdump::ndsp::PLLCarrierTrackingBlock, satdump::ndsp::PSKDemodHierBlock, satdump::ndsp::QuadratureDemodBlock, satdump::ndsp::RationalResamplerBlock< T >, satdump::ndsp::RealToComplexBlock, satdump::ndsp::SamplerateMeterBlock< T >, satdump::ndsp::ShortToFloatBlock, satdump::ndsp::SplitterBlock< T >, satdump::ndsp::SubtractBlock< T >, satdump::ndsp::ThrottleBlock< T >, satdump::ndsp::UCharToFloatBlock, satdump::ndsp::VCOBlock, and satdump::ndsp::WaveformBlock< T >.

is_async()

virtual bool satdump::ndsp::Block::is_async ( )

inlinevirtual

Returns true if a block is async. An async block is a block that has outputs without inputs or inputs that won't directly affect/stop the outputs' behavior. This includes sources (eg, a SDR Device), TXing and RXing at the same time, and anything with similar requirements.

Returns

true if the block is async

link()

void satdump::ndsp::Block::link ( Block * ptr, int output_index, int input_index, int nbuf )

inline

Link a block's output to another input, more or less just a warper around set_input and set_output.

Parameters

ptr	block to get the output from
output_index	index of the output to use, from ptr
input_index	index of the input to asign no (this block, NOT ptr)
nbuf	of buffers to setup in the output (see set_input for more info)

Returns

BlockIO struct of the output

set_cfg() [1/2]

cfg_res_t satdump::ndsp::Block::set_cfg ( nlohmann::json v )

inline

Set parameters of the block from JSON. Essentially the same as set_cfg(key, v), except this will set any number of them at once.

Parameters

v	values to set

Returns

highest error code or status

set_cfg() [2/2]

virtual cfg_res_t satdump::ndsp::Block::set_cfg ( std::string key, nlohmann::json v )

pure virtual

Set parameters of the block from JSON, including potentially IO configurations for blocks that may have variable output sizes. However, you likely should implemenet that in a separate function as well (eg, addVFO or such) for it to be easy to be done in C++ directly, and using said function here. Optionally, this can also be made to be functional while the block is running!

Parameters

key	parameter to set
v	value to set

Returns

error code or status.

Implemented in satdump::ndsp::AddBlock< T >, satdump::ndsp::AGCBlock< T >, satdump::ndsp::AGCBlock< complex_t >, satdump::ndsp::BlankerBlock< T >, satdump::ndsp::BlkAGCBlock< T >, satdump::ndsp::ChannelModelSimpleBlock, satdump::ndsp::CharToFloatBlock, satdump::ndsp::ComplexToFloatBlock, satdump::ndsp::ComplexToIFloatBlock, satdump::ndsp::ComplexToImagBlock, satdump::ndsp::ComplexToMagBlock, satdump::ndsp::ComplexToMagSquaredBlock, satdump::ndsp::ComplexToRealBlock, satdump::ndsp::ConstellationDisplayBlock, satdump::ndsp::CorrectIQBlock< T >, satdump::ndsp::CostasBlock, satdump::ndsp::CyclostationaryAnalysis, satdump::ndsp::DelayOneImagBlock, satdump::ndsp::ExponentiateBlock, satdump::ndsp::FFTPanBlock, satdump::ndsp::FileSinkBlock< T >, satdump::ndsp::FileSourceBlock< T >, satdump::ndsp::FIRBlock< T >, satdump::ndsp::FIRBlock< complex_t >, satdump::ndsp::FloatToCharBlock, satdump::ndsp::FloatToComplexBlock, satdump::ndsp::FreqShiftBlock, satdump::ndsp::HilbertBlock, satdump::ndsp::HistogramDisplayBlock, satdump::ndsp::IFloatToComplexBlock, satdump::ndsp::IQSinkBlock, satdump::ndsp::IQSourceBlock, satdump::ndsp::MMClockRecoveryBlock< T >, satdump::ndsp::MMClockRecoveryBlock< complex_t >, satdump::ndsp::MMClockRecoveryFastBlock< T >, satdump::ndsp::MultiplyBlock< T >, satdump::ndsp::NNGIQSinkBlock, satdump::ndsp::PLLCarrierTrackingBlock, satdump::ndsp::PSKDemodHierBlock, satdump::ndsp::QuadratureDemodBlock, satdump::ndsp::RationalResamplerBlock< T >, satdump::ndsp::RealToComplexBlock, satdump::ndsp::RRC_FIRBlock< T >, satdump::ndsp::RRC_FIRBlock< complex_t >, satdump::ndsp::SamplerateMeterBlock< T >, satdump::ndsp::ShortToFloatBlock, satdump::ndsp::SplitterBlock< T >, satdump::ndsp::SubtractBlock< T >, satdump::ndsp::ThrottleBlock< T >, satdump::ndsp::UCharToFloatBlock, satdump::ndsp::VCOBlock, and satdump::ndsp::WaveformBlock< T >.

set_input()

virtual void satdump::ndsp::Block::set_input ( BlockIO f, int i )

inlinevirtual

Link an input to an output stream of some sort. This also checks the type of the BlockIO to ensure (some level of) compatibility.

Parameters

f	input BlockIO to link to an input
i	index of the input (probably quite often 0)

Reimplemented in satdump::ndsp::PSKDemodHierBlock.

start()

virtual void satdump::ndsp::Block::start ( )

inlinevirtual

Starts this block's internal thread and loop.

Reimplemented in satdump::ndsp::IQSinkBlock, satdump::ndsp::NNGIQSinkBlock, and satdump::ndsp::PSKDemodHierBlock.

stop()

virtual void satdump::ndsp::Block::stop ( bool stop_now = false, bool force = false )

inlinevirtual

Stops the block, or rather tells the internal loop it should exit & joins the thread to wait. TODOREWORK, potentially allow sending the terminator as well to force-quit.

Parameters

stop_now	the normal stop just marks the block for stopping when convenient, when the work() function exists by itself. Setting this to true will tell the block to stop now if it can send a terminator.
force	this will exit work() as soon as possible, leaving it in an unknown state. Do not use until it is for live-reconfiguration!

Reimplemented in satdump::ndsp::IQSinkBlock, satdump::ndsp::NNGIQSinkBlock, and satdump::ndsp::PSKDemodHierBlock.

work()

virtual bool satdump::ndsp::Block::work ( )

protectedpure virtual

The actual looping work function meant to handle all the DSP (well, in most blocks)

Returns

true if block's thread should exit, usually upon receiving a terminator in the input stream

Implemented in satdump::ndsp::ConstellationDisplayBlock, satdump::ndsp::HistogramDisplayBlock, and satdump::ndsp::PSKDemodHierBlock.

---

The documentation for this class was generated from the following file:

• src-core/dsp/block.h