Loading...
Searching...
No Matches
gr-fec/include/gnuradio/fec/encoder.h
Go to the documentation of this file.
/* -*- c++ -*- */
/*
* Copyright 2013-2014 Free Software Foundation, Inc.
*
* This file is part of GNU Radio
*
* SPDX-License-Identifier: GPL-3.0-or-later
*
*/
#ifndef INCLUDED_FEC_ENCODER_H
#define INCLUDED_FEC_ENCODER_H
#include <gnuradio/block.h>
#include <gnuradio/fec/api.h>
#include <gnuradio/fec/generic_encoder.h>
#include <memory>
namespace gr {
namespace fec {
/*!
* \brief Creates the encoder block for use in GNU Radio
* flowgraphs from a given FECAPI object derived from the
* generic_encoder class.
* \ingroup error_coding_blk
*
* \details
*
* Generally, we would use the fec.extended_encoder Python
* implementation to instantiate this. The extended_encoder wraps
* up a few more details, like taking care of puncturing as well
* as the encoder itself.
*/
class FEC_API encoder : virtual public block
{
public:
typedef std::shared_ptr<encoder> sptr;
/*!
* Build the FEC encoder block from an FECAPI encoder object.
*
* \param my_encoder An FECAPI encoder object child of the generic_encoder class.
* \param input_item_size size of a block of data for the encoder.
* \param output_item_size size of a block of data the encoder will produce.
*/
static sptr make(generic_encoder::sptr my_encoder,
size_t input_item_size,
size_t output_item_size);
int general_work(int noutput_items,
gr_vector_int& ninput_items,
gr_vector_const_void_star& input_items,
gr_vector_void_star& output_items) override = 0;
int fixed_rate_ninput_to_noutput(int ninput) override = 0;
int fixed_rate_noutput_to_ninput(int noutput) override = 0;
void forecast(int noutput_items, gr_vector_int& ninput_items_required) override = 0;
};
} /* namespace fec */
} /* namespace gr */
#endif /* INCLUDED_FEC_ENCODER_H */
gr::block::block
block(void)
Definition gnuradio-runtime/include/gnuradio/block.h:806
gr::fec::encoder
Creates the encoder block for use in GNU Radio flowgraphs from a given FECAPI object derived from the...
Definition gr-fec/include/gnuradio/fec/encoder.h:36
gr::fec::encoder::fixed_rate_ninput_to_noutput
int fixed_rate_ninput_to_noutput(int ninput) override=0
Given ninput samples, return number of output samples that will be produced. N.B. this is only define...
gr::fec::encoder::make
static sptr make(generic_encoder::sptr my_encoder, size_t input_item_size, size_t output_item_size)
gr::fec::encoder::forecast
void forecast(int noutput_items, gr_vector_int &ninput_items_required) override=0
Estimate input requirements given output request.
gr::fec::encoder::sptr
std::shared_ptr< encoder > sptr
Definition gr-fec/include/gnuradio/fec/encoder.h:38
gr::fec::encoder::fixed_rate_noutput_to_ninput
int fixed_rate_noutput_to_ninput(int noutput) override=0
Given noutput samples, return number of input samples required to produce noutput....
gr::fec::encoder::general_work
int general_work(int noutput_items, gr_vector_int &ninput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items) override=0
compute output items from input items
gr::fec::generic_encoder::sptr
std::shared_ptr< generic_encoder > sptr
Definition generic_encoder.h:37
generic_encoder.h
block.h
api.h
FEC_API
#define FEC_API
Definition gr-fec/include/gnuradio/fec/api.h:18
gr::fec
Definition async_decoder.h:20
gr
GNU Radio logging wrapper.
Definition basic_block.h:29
gr_vector_const_void_star
std::vector< const void * > gr_vector_const_void_star
Definition types.h:28
gr_vector_void_star
std::vector< void * > gr_vector_void_star
Definition types.h:27
gr_vector_int
std::vector< int > gr_vector_int
Definition types.h:23