Parent class for FECAPI objects.
Parent of a decoder variable class for FECAPI that will fit into the gr::fec::decoder block to handle FEC decoding. This class provides the basic information required to fit into the FECAPI structure. It provides information about input and output data types, potential data conversions, and a few other parameters useful to establish the decoder's behavior.
We create objects from FECAPI-derived classes to go into the actual GNU Radio decoder block. Each object contains its own state and so there should be a one-to-one mapping of an FECAPI object and a GR decoder block. Sharing these objects is not guaranteed to be thread-safe.
This is a pure virtual class and must be derived from by a child class.
- See also
- gr::fec::code::cc_decoder
-
gr::fec::code::ccsds_decoder
| virtual const char* gr::fec::generic_decoder::get_input_conversion |
( |
| ) |
|
|
virtual |
Set up a conversion type required to setup the data properly for this decoder. The decoder itself will not implement the conversion and expects an external wrapper (e.g., fec.extended_decoder) to read this value and "do the right
thing" to format the data.
The default behavior is 'none', which means no conversion is required. Whatever the get_input_item_size() value returns, the input is expected to conform directly to this.
This may also return 'uchar', which indicates that the wrapper should convert the standard float samples to unsigned characters, either hard sliced or 8-bit soft symbols. See gr::fec::code::cc_decoder as an example decoder that uses this conversion format.
If 'packed_bits', the block expects the inputs to be packed hard bits. Each input item is a unsigned char where each of the 8-bits is a hard bit value.
The child class SHOULD implement this function. If not reimplemented, it returns "none".
| virtual int gr::fec::generic_decoder::get_input_size |
( |
| ) |
|
|
pure virtual |
Returns the input size in items that the decoder object uses to decode a full frame. Often, this number is the number of bits per frame if the input format is unpacked. If the block expects packed bytes, then this value should be the number of bytes (number of bits / 8) per input frame.
The child class MUST implement this function.
Implemented in gr::fec::ldpc_decoder, and gr::fec::code::polar_decoder_common.
| virtual const char* gr::fec::generic_decoder::get_output_conversion |
( |
| ) |
|
|
virtual |
Set up a conversion type required to understand the output style of this decoder. Generally, follow-on processing expects unpacked bits, so we specify the conversion type here to indicate what the wrapper (e.g., fec.extended_decoder) should do to convert the output samples from the decoder into unpacked bits.
The default behavior is 'none', which means no conversion is required. This should mean that the output data is produced from this decoder as unpacked bit.
If 'unpack', the block produces packed bytes that should be unpacked by the wrapper. See gr::fec::code::ccsds_decoder as an example of a decoder that produces packed bytes.
The child class SHOULD implement this function. If not reimplemented, it returns "none".
| virtual int gr::fec::generic_decoder::get_output_size |
( |
| ) |
|
|
pure virtual |
Returns the output size in items that the decoder object produces after decoding a full frame. Often, this number is the number of bits in the outputted frame if the input format is unpacked. If the block produces packed bytes, then this value should be the number of bytes (number of bits / 8) per frame produced. This value is generally something like get_input_size()/R for a 1/R rate code.
The child class MUST implement this function.
Implemented in gr::fec::ldpc_decoder, and gr::fec::code::polar_decoder_common.
| virtual float gr::fec::generic_decoder::get_shift |
( |
| ) |
|
|
virtual |
Some decoders require the input items to float around a particular soft value. We can set that floating value by setting this value to return some non-zero number.
The fec.extended_decoder block will use this to create an add_const_ff block before the decoder block to adjust all input samples appropriately.
The child class MAY implement this function. If not reimplemented, it returns 0.
1.8.8