gr::fec::generic_decoder
gr::fec::code::cc_decoder
gr::fec::code::dummy_decoder
gr::fec::code::ldpc_bit_flip_decoder
gr::fec::code::polar_decoder_common
gr::fec::code::repetition_decoder
gr::fec::ldpc_decoder
gr::fec::tpc_decoder
gnuradio/fec/generic_decoder.h
std::shared_ptr< generic_decoder > std::shared_ptr<generic_decoder> gr::fec::generic_decoder::sptr sptr gr::fec::generic_decoder::sptr
gr::logger_ptr gr::logger_ptr gr::fec::generic_decoder::d_logger d_logger gr::fec::generic_decoder::d_logger
class friend class decoder decoder gr::fec::generic_decoder::decoder decoder
int int gr::fec::generic_decoder::base_unique_id base_unique_id gr::fec::generic_decoder::base_unique_id
int int gr::fec::generic_decoder::my_id my_id gr::fec::generic_decoder::my_id
std::string std::string gr::fec::generic_decoder::d_name d_name gr::fec::generic_decoder::d_name
void virtual void gr::fec::generic_decoder::generic_work (void *inbuffer, void *outbuffer)=0 generic_work gr::fec::generic_decoder::generic_work generic_work generic_work generic_work generic_work generic_work void * inbuffer void * outbuffer
int int gr::fec::generic_decoder::unique_id () unique_id gr::fec::generic_decoder::unique_id
std::string std::string gr::fec::generic_decoder::alias () alias gr::fec::generic_decoder::alias
gr::fec::generic_decoder::generic_decoder
(void)
generic_decoder
gr::fec::generic_decoder::generic_decoder
void
gr::fec::generic_decoder::generic_decoder
(std::string name)
generic_decoder
gr::fec::generic_decoder::generic_decoder
std::string name
virtual gr::fec::generic_decoder::~generic_decoder
()
~generic_decoder
gr::fec::generic_decoder::~generic_decoder
double virtual double gr::fec::generic_decoder::rate ()=0 rate gr::fec::generic_decoder::rate rate rate rate rate rate rate rate

Returns the rate of the code. For every r input bits, there is 1 output bit, so the rate is 1/r. Used for setting things like the encoder block's relative rate.

This function MUST be reimplemented by the child class.

int virtual int gr::fec::generic_decoder::get_input_size ()=0 get_input_size gr::fec::generic_decoder::get_input_size get_input_size get_input_size get_input_size

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.

int virtual int gr::fec::generic_decoder::get_output_size ()=0 get_output_size gr::fec::generic_decoder::get_output_size get_output_size get_output_size get_output_size

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.

int virtual int gr::fec::generic_decoder::get_history () get_history gr::fec::generic_decoder::get_history get_history get_history

Sets up history for the decoder when the decoder is required to look ahead in the data stream in order to finish its processing.

The child class MAY implement this function. If not reimplemented, it returns 0.

float virtual float gr::fec::generic_decoder::get_shift () get_shift gr::fec::generic_decoder::get_shift get_shift get_shift

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.

int virtual int gr::fec::generic_decoder::get_input_item_size () get_input_item_size gr::fec::generic_decoder::get_input_item_size get_input_item_size get_input_item_size

Sets the size of an input item, as in the size of a char or float item.

The child class SHOULD implement this function. If not reimplemented, it returns sizeof(float) as the decoders typically expect floating point input types.

int virtual int gr::fec::generic_decoder::get_output_item_size () get_output_item_size gr::fec::generic_decoder::get_output_item_size get_output_item_size get_output_item_size

Sets the size of an output item, as in the size of a char or float item.

The child class SHOULD implement this function. If not reimplemented, it returns sizeof(char) as the decoders typically expect to produce bits or bytes.

const char * virtual const char * gr::fec::generic_decoder::get_input_conversion () get_input_conversion gr::fec::generic_decoder::get_input_conversion

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".

const char * virtual const char * gr::fec::generic_decoder::get_output_conversion () get_output_conversion gr::fec::generic_decoder::get_output_conversion

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".

bool virtual bool gr::fec::generic_decoder::set_frame_size (unsigned int frame_size)=0 set_frame_size gr::fec::generic_decoder::set_frame_size set_frame_size set_frame_size set_frame_size set_frame_size set_frame_size set_frame_size set_frame_size unsigned int frame_size

Updates the size of a decoded frame.

The child class MUST implement this function and interpret how the `frame_size` information affects the block's behavior. It should also provide bounds checks.

float virtual float gr::fec::generic_decoder::get_iterations () get_iterations gr::fec::generic_decoder::get_iterations get_iterations

Get repetitions to decode.

The child class should implement this function and return the number of iterations required to decode.

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.

gr::fec::code::cc_decoder

gr::fec::code::ccsds_decoder

gr::fec::code::cc_decoder
gr::fec::code::dummy_decoder
gr::fec::code::ldpc_bit_flip_decoder
gr::fec::code::polar_decoder_common
gr::fec::code::polar_decoder_sc
gr::fec::code::polar_decoder_sc_list
gr::fec::code::polar_decoder_sc_systematic
gr::fec::code::repetition_decoder
gr::fec::generic_decoder
gr::fec::ldpc_decoder
gr::fec::tpc_decoder
gr::fec::generic_decoder
d_logger
d_name
std::basic_string< Char >
std::shared_ptr< logger >
std::string
- gr::fec::generic_decoder
  alias
- gr::fec::generic_decoder
  base_unique_id
- gr::fec::generic_decoder
  d_logger
- gr::fec::generic_decoder
  d_name
- gr::fec::generic_decoder
  decoder
- gr::fec::generic_decoder
  generic_decoder
- gr::fec::generic_decoder
  generic_decoder
- gr::fec::generic_decoder
  generic_work
- gr::fec::generic_decoder
  get_history
- gr::fec::generic_decoder
  get_input_conversion
- gr::fec::generic_decoder
  get_input_item_size
- gr::fec::generic_decoder
  get_input_size
- gr::fec::generic_decoder
  get_iterations
- gr::fec::generic_decoder
  get_output_conversion
- gr::fec::generic_decoder
  get_output_item_size
- gr::fec::generic_decoder
  get_output_size
- gr::fec::generic_decoder
  get_shift
- gr::fec::generic_decoder
  my_id
- gr::fec::generic_decoder
  rate
- gr::fec::generic_decoder
  set_frame_size
- gr::fec::generic_decoder
  sptr
- gr::fec::generic_decoder
  unique_id
- gr::fec::generic_decoder
  ~generic_decoder