summaryrefslogtreecommitdiff
path: root/gr-fec/include/gnuradio/fec/async_decoder.h
blob: 46fa9bef2726fa2ef1e195cc358ebe13fed223a1 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
/* -*- c++ -*- */
/*
 * Copyright 2014 Free Software Foundation, Inc.
 *
 * This file is part of GNU Radio
 *
 * GNU Radio is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 3, or (at your option)
 * any later version.
 *
 * GNU Radio is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with GNU Radio; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street,
 * Boston, MA 02110-1301, USA.
 */

#ifndef INCLUDED_FEC_ASYNC_DECODER_H
#define INCLUDED_FEC_ASYNC_DECODER_H

#include <gnuradio/fec/api.h>
#include <gnuradio/fec/generic_decoder.h>
#include <gnuradio/block.h>
#include <boost/shared_ptr.hpp>

namespace gr {
  namespace fec {

    /*!
     * \brief Creates the decoder block for use in GNU Radio
     * flowgraphs from a given FECAPI object derived from the
     * generic_decoder class.
     * \ingroup error_coding_blk
     *
     * \details
     *
     * Decodes frames received as a PDU over a message port.
     */
    class FEC_API async_decoder : virtual public block
    {
    public:
      typedef boost::shared_ptr<async_decoder> sptr;

      /*!
       * Build the PDU-based FEC decoder block from an FECAPI decoder object.
       *
       * \param my_decoder An FECAPI decoder object child of the generic_decoder class.
       * \param packed Sets output to packed bytes if true; otherwise, 1 bit per byte
       * \param rev_pack If packing bits, should they be reversed?
       */
      static sptr make(generic_decoder::sptr my_decoder,
                       bool packed=false, bool rev_pack=true);

      virtual int general_work(int noutput_items,
                               gr_vector_int& ninput_items,
                               gr_vector_const_void_star &input_items,
                               gr_vector_void_star &output_items) = 0;
    };

  } /* namespace fec */
} /* namespace gr */

#endif /* INCLUDED_FEC_ASYNC_DECODER_H */