GNU Radio's SATNOGS Package
ax100_mode5_encoder.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) 2021-2023, 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 * SPDX-License-Identifier: GNU General Public License v3.0 or later
21 */
22
23#ifndef INCLUDED_SATNOGS_AX100_MODE5_ENCODER_H
24#define INCLUDED_SATNOGS_AX100_MODE5_ENCODER_H
25
30#include <vector>
31
32namespace gr {
33namespace satnogs {
34
35/*!
36 * \brief This encoder implements the AX100 mode 5 framing and coding scheme
37 *
38 */
40{
41public:
42 using sptr = std::shared_ptr<ax100_mode5_encoder>;
43
44 /**
45 * @brief Coded Length field length in bytes
46 *
47 */
48 static constexpr size_t length_size = 3;
49
50 static sptr make(const std::vector<uint8_t>& preamble,
51 const std::vector<uint8_t>& sync,
54 bool enable_rs = true);
55
56 ax100_mode5_encoder(const std::vector<uint8_t>& preamble,
57 const std::vector<uint8_t>& sync,
59 whitening::sptr scrambler,
60 bool enable_rs);
62
63 pmt::pmt_t encode(pmt::pmt_t msg);
64
65private:
66 const crc::type d_crc;
67 const bool d_rs;
68 const size_t d_payload_start;
69 whitening::sptr d_scrambler;
70 uint8_t* d_pdu;
71};
72
73} // namespace satnogs
74} // namespace gr
75
76#endif /* INCLUDED_SATNOGS_AX100_MODE5_ENCODER_H */
#define SATNOGS_API
Definition: api.h:19
This encoder implements the AX100 mode 5 framing and coding scheme.
Definition: ax100_mode5_encoder.h:40
ax100_mode5_encoder(const std::vector< uint8_t > &preamble, const std::vector< uint8_t > &sync, crc::type crc, whitening::sptr scrambler, bool enable_rs)
std::shared_ptr< ax100_mode5_encoder > sptr
Definition: ax100_mode5_encoder.h:42
static sptr make(const std::vector< uint8_t > &preamble, const std::vector< uint8_t > &sync, crc::type crc=crc::type::CRC32_C, whitening::sptr scrambler=whitening::make_ccsds(), bool enable_rs=true)
pmt::pmt_t encode(pmt::pmt_t msg)
Definition: crc.h:44
type
Predefined CRC types.
Definition: crc.h:51
@ CRC32_C
Alias: CRC-16/ACORN, CRC-16/LTE, CRC-16/V-41-MSB, XMODEM, ZMODEM.
Abstract class defining the API of the SatNOGS Encoders.
Definition: encoder.h:44
std::shared_ptr< whitening > sptr
Definition: whitening.h:42
static sptr make_ccsds(bool msb=false)
Definition: amsat_duv_decoder.h:29