diff options
Diffstat (limited to 'gr-fec/include/gnuradio/fec/ccsds_encoder.h')
| -rw-r--r-- | gr-fec/include/gnuradio/fec/ccsds_encoder.h | 154 |
1 files changed, 76 insertions, 78 deletions
diff --git a/gr-fec/include/gnuradio/fec/ccsds_encoder.h b/gr-fec/include/gnuradio/fec/ccsds_encoder.h index f482ad90f7..4eca78084e 100644 --- a/gr-fec/include/gnuradio/fec/ccsds_encoder.h +++ b/gr-fec/include/gnuradio/fec/ccsds_encoder.h @@ -30,88 +30,86 @@ #include <string> namespace gr { - namespace fec { - namespace code { +namespace fec { +namespace code { - /*! - * \brief CCSDS Encoding class for convolutional encoding with - * rate 1/2, K=7, and polynomials [109, 79]. - * \ingroup error_coding_blk - * - * \details - * - * Uses Phil Karn's (KA9Q) implementation of the CCSDS encoder - * for rate 1/2, K=7, and CC polynomial [109, 79]. These are - * non-adjustable in this encoder. For an adjustable CC encoder - * where we can set the rate, constraint length, and polynomial, - * see gr::fec::code::cc_encoder. - * - * The encoder is set up with a number of bits per frame in the - * constructor. When not being used in a tagged stream mode, - * this encoder will only process frames of the length provided - * here. If used in a tagged stream block, this setting becomes - * the maximum allowable frame size that the block may process. - * - * The \p mode is a cc_mode_t that specifies how the convolutional - * encoder will behave and under what conditions. - * - * \li 'CC_STREAMING': mode expects an uninterrupted flow of - * samples into the encoder, and the output stream is - * continually encoded. - * - * \li 'CC_TERMINATED': is a mode designed for packet-based - * systems. This mode adds rate*(k-1) bits to the output as a - * way to help flush the decoder. - * - * \li 'CC_TAILBITING': is another packet-based method. Instead of - * adding bits onto the end of the packet, this mode will - * continue the code between the payloads of packets by - * pre-initializing the state of the new packet based on the - * state of the last packet for (k-1) bits. - * - * \li 'CC_TRUNCATED': a truncated code always resets the registers - * to the \p start_state between frames. - * - * A common convolutional encoder uses K=7, Rate=1/2, - * Polynomials=[109, 79]. This is the Voyager code from NASA: - * \li 109: b(1101101) --> 1 + x + x^3 + x^4 + x^6 - * \li 79: b(1001111) --> 1 + x^3 + x^4 + x^5 + x^6 - */ - class FEC_API ccsds_encoder : virtual public generic_encoder - { - public: - - /*! - * Build the CCSDS (rate=1/2, K=7, polys=[109,79] - * convolutional code FECAPI object. - * - * \param frame_size Number of bits per frame. If using in the - * tagged stream style, this is the maximum allowable - * number of bits per frame. - * \param start_state Initialization state of the shift register. - * \param mode cc_mode_t mode of the encoding. - */ - static generic_encoder::sptr make - (int frame_size, int start_state = 0, - cc_mode_t mode=CC_STREAMING); +/*! + * \brief CCSDS Encoding class for convolutional encoding with + * rate 1/2, K=7, and polynomials [109, 79]. + * \ingroup error_coding_blk + * + * \details + * + * Uses Phil Karn's (KA9Q) implementation of the CCSDS encoder + * for rate 1/2, K=7, and CC polynomial [109, 79]. These are + * non-adjustable in this encoder. For an adjustable CC encoder + * where we can set the rate, constraint length, and polynomial, + * see gr::fec::code::cc_encoder. + * + * The encoder is set up with a number of bits per frame in the + * constructor. When not being used in a tagged stream mode, + * this encoder will only process frames of the length provided + * here. If used in a tagged stream block, this setting becomes + * the maximum allowable frame size that the block may process. + * + * The \p mode is a cc_mode_t that specifies how the convolutional + * encoder will behave and under what conditions. + * + * \li 'CC_STREAMING': mode expects an uninterrupted flow of + * samples into the encoder, and the output stream is + * continually encoded. + * + * \li 'CC_TERMINATED': is a mode designed for packet-based + * systems. This mode adds rate*(k-1) bits to the output as a + * way to help flush the decoder. + * + * \li 'CC_TAILBITING': is another packet-based method. Instead of + * adding bits onto the end of the packet, this mode will + * continue the code between the payloads of packets by + * pre-initializing the state of the new packet based on the + * state of the last packet for (k-1) bits. + * + * \li 'CC_TRUNCATED': a truncated code always resets the registers + * to the \p start_state between frames. + * + * A common convolutional encoder uses K=7, Rate=1/2, + * Polynomials=[109, 79]. This is the Voyager code from NASA: + * \li 109: b(1101101) --> 1 + x + x^3 + x^4 + x^6 + * \li 79: b(1001111) --> 1 + x^3 + x^4 + x^5 + x^6 + */ +class FEC_API ccsds_encoder : virtual public generic_encoder +{ +public: + /*! + * Build the CCSDS (rate=1/2, K=7, polys=[109,79] + * convolutional code FECAPI object. + * + * \param frame_size Number of bits per frame. If using in the + * tagged stream style, this is the maximum allowable + * number of bits per frame. + * \param start_state Initialization state of the shift register. + * \param mode cc_mode_t mode of the encoding. + */ + static generic_encoder::sptr + make(int frame_size, int start_state = 0, cc_mode_t mode = CC_STREAMING); - /*! - * Sets the uncoded frame size to \p frame_size. If \p - * frame_size is greater than the value given to the - * constructor, the frame size will be capped by that initial - * value and this function will return false. Otherwise, it - * returns true. - */ - virtual bool set_frame_size(unsigned int frame_size) = 0; + /*! + * Sets the uncoded frame size to \p frame_size. If \p + * frame_size is greater than the value given to the + * constructor, the frame size will be capped by that initial + * value and this function will return false. Otherwise, it + * returns true. + */ + virtual bool set_frame_size(unsigned int frame_size) = 0; - /*! - * Returns the coding rate of this encoder. - */ - virtual double rate() = 0; - }; + /*! + * Returns the coding rate of this encoder. + */ + virtual double rate() = 0; +}; - } /* namespace code */ - } /* namespace fec */ +} /* namespace code */ +} /* namespace fec */ } /* namespace gr */ #endif /* INCLUDED_FEC_CCSDS_ENCODER_H */ |