GNU Radio Manual and C++ API Reference  3.10.9.1
The Free & Open Software Radio Ecosystem
tagged_encoder.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * Copyright 2014 Free Software Foundation, Inc.
4  *
5  * This file is part of GNU Radio
6  *
7  * SPDX-License-Identifier: GPL-3.0-or-later
8  *
9  */
10 
11 #ifndef INCLUDED_FEC_TAGGED_ENCODER_H
12 #define INCLUDED_FEC_TAGGED_ENCODER_H
13 
14 #include <gnuradio/fec/api.h>
17 #include <memory>
18 
19 namespace gr {
20 namespace fec {
21 
22 /*!
23  * \brief Creates the encoder block for use in GNU Radio
24  * flowgraphs from a given FECAPI object derived from the
25  * generic_encoder class.
26  * \ingroup error_coding_blk
27  *
28  * \details
29  *
30  * Generally, we would use the fec.extended_encoder Python
31  * implementation to instantiate this. The extended_encoder wraps
32  * up a few more details, like taking care of puncturing as well
33  * as the encoder itself.
34  */
36 {
37 public:
38  typedef std::shared_ptr<tagged_encoder> sptr;
39 
40  /*!
41  * Build the FEC encoder block from an FECAPI encoder object.
42  *
43  * \param my_encoder An FECAPI encoder object child of the generic_encoder class.
44  * \param input_item_size size of a block of data for the encoder.
45  * \param output_item_size size of a block of data the encoder will produce.
46  * \param lengthtagname Key name of the tagged stream frame size.
47  * \param mtu The Maximum Transmission Unit (MTU) of the input
48  * frame that the block will be able to
49  * process. Specified in bytes and defaults to 1500.
50  */
51  static sptr make(generic_encoder::sptr my_encoder,
52  size_t input_item_size,
53  size_t output_item_size,
54  const std::string& lengthtagname = "packet_len",
55  int mtu = 1500);
56 
57  int work(int noutput_items,
58  gr_vector_int& ninput_items,
59  gr_vector_const_void_star& input_items,
60  gr_vector_void_star& output_items) override = 0;
61  int calculate_output_stream_length(const gr_vector_int& ninput_items) override = 0;
62 };
63 
64 } /* namespace fec */
65 } /* namespace gr */
66 
67 #endif /* INCLUDED_FEC_TAGGED_ENCODER_H */
std::shared_ptr< generic_encoder > sptr
Definition: generic_encoder.h:37
Creates the encoder block for use in GNU Radio flowgraphs from a given FECAPI object derived from the...
Definition: tagged_encoder.h:36
int work(int noutput_items, gr_vector_int &ninput_items, gr_vector_const_void_star &input_items, gr_vector_void_star &output_items) override=0
Just like gr::block::general_work, but makes sure the input is valid.
int calculate_output_stream_length(const gr_vector_int &ninput_items) override=0
Calculate the number of output items.
static sptr make(generic_encoder::sptr my_encoder, size_t input_item_size, size_t output_item_size, const std::string &lengthtagname="packet_len", int mtu=1500)
std::shared_ptr< tagged_encoder > sptr
Definition: tagged_encoder.h:38
Block that operates on PDUs in form of tagged streams.
Definition: tagged_stream_block.h:26
#define FEC_API
Definition: gr-fec/include/gnuradio/fec/api.h:18
GNU Radio logging wrapper.
Definition: basic_block.h:29
std::vector< const void * > gr_vector_const_void_star
Definition: types.h:28
std::vector< void * > gr_vector_void_star
Definition: types.h:27
std::vector< int > gr_vector_int
Definition: types.h:23