GNU Radio's SATNOGS Package
frame_decoder.h
Go to the documentation of this file.
1 /* -*- c++ -*- */
2 /*
3  * gr-satnogs: SatNOGS GNU Radio Out-Of-Tree Module
4  *
5  * Copyright (C) 2019, Libre Space Foundation <http://libre.space>
6  *
7  * This program is free software: you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation, either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program. If not, see <http://www.gnu.org/licenses/>.
19  */
20 
21 #ifndef INCLUDED_SATNOGS_FRAME_DECODER_H
22 #define INCLUDED_SATNOGS_FRAME_DECODER_H
23 
24 #include <satnogs/api.h>
25 #include <gnuradio/sync_block.h>
26 #include <satnogs/decoder.h>
27 
28 namespace gr {
29 namespace satnogs {
30 
31 /*!
32  * \brief This is a generic frame decoder block. It takes as input a
33  * bit stream and produces decoded frames and their metadata.
34  *
35  * The decoding is performed by using a proper decoder object.
36  * Each decoder implements the virtual class ::decoder()
37  *
38  * The frame and metadata are produced in a pmt dictionary, with the
39  * keys "pdu" and "metadata".
40  *
41  * \ingroup satnogs
42  *
43  */
44 class SATNOGS_API frame_decoder : virtual public gr::sync_block {
45 public:
46  typedef boost::shared_ptr<frame_decoder> sptr;
47 
48  /*!
49  * \brief Return a shared_ptr to a new instance of satnogs::frame_decoder.
50  * @param decoder_object the decoder object to use
51  */
52  static sptr make(decoder::decoder_sptr decoder_object, int input_size);
53 };
54 
55 } // namespace satnogs
56 } // namespace gr
57 
58 #endif /* INCLUDED_SATNOGS_FRAME_DECODER_H */
59 
boost::shared_ptr< frame_decoder > sptr
Definition: frame_decoder.h:46
This is a generic frame decoder block. It takes as input a bit stream and produces decoded frames and...
Definition: frame_decoder.h:44
Definition: amsat_duv_decoder.h:29
#define SATNOGS_API
Definition: api.h:30