Neels Hofmeyr | 17518fe | 2017-06-20 04:35:06 +0200 | [diff] [blame] | 1 | /*! \file conv.h |
| 2 | * Osmocom convolutional encoder and decoder. */ |
Sylvain Munaut | 19dc5c9 | 2011-04-23 16:09:19 +0200 | [diff] [blame] | 3 | /* |
Sylvain Munaut | 19dc5c9 | 2011-04-23 16:09:19 +0200 | [diff] [blame] | 4 | * Copyright (C) 2011 Sylvain Munaut <tnt@246tNt.com> |
| 5 | * |
| 6 | * All Rights Reserved |
| 7 | * |
| 8 | * This program is free software; you can redistribute it and/or modify |
| 9 | * it under the terms of the GNU General Public License as published by |
| 10 | * the Free Software Foundation; either version 2 of the License, or |
| 11 | * (at your option) any later version. |
| 12 | * |
| 13 | * This program is distributed in the hope that it will be useful, |
| 14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 16 | * GNU General Public License for more details. |
| 17 | * |
| 18 | * You should have received a copy of the GNU General Public License along |
| 19 | * with this program; if not, write to the Free Software Foundation, Inc., |
| 20 | * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. |
| 21 | */ |
| 22 | |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 23 | /*! \defgroup conv Convolutional encoding and decoding routines |
| 24 | * @{ |
Neels Hofmeyr | 17518fe | 2017-06-20 04:35:06 +0200 | [diff] [blame] | 25 | * \file conv.h */ |
Harald Welte | ba6988b | 2011-08-17 12:46:48 +0200 | [diff] [blame] | 26 | |
Sylvain Munaut | 12ba778 | 2014-06-16 10:13:40 +0200 | [diff] [blame] | 27 | #pragma once |
Sylvain Munaut | 19dc5c9 | 2011-04-23 16:09:19 +0200 | [diff] [blame] | 28 | |
| 29 | #include <stdint.h> |
| 30 | |
| 31 | #include <osmocom/core/bits.h> |
| 32 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 33 | /*! possibe termination types |
Sylvain Munaut | 297d13f | 2011-11-24 17:46:58 +0100 | [diff] [blame] | 34 | * |
| 35 | * The termination type will determine which state the encoder/decoder |
| 36 | * can start/end with. This is mostly taken care of in the high level API |
| 37 | * call. So if you use the low level API, you must take care of making the |
| 38 | * proper calls yourself. |
| 39 | */ |
| 40 | enum osmo_conv_term { |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 41 | CONV_TERM_FLUSH = 0, /*!< Flush encoder state */ |
| 42 | CONV_TERM_TRUNCATION, /*!< Direct truncation */ |
| 43 | CONV_TERM_TAIL_BITING, /*!< Tail biting */ |
Sylvain Munaut | 297d13f | 2011-11-24 17:46:58 +0100 | [diff] [blame] | 44 | }; |
| 45 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 46 | /*! structure describing a given convolutional code |
Sylvain Munaut | 03d2c89 | 2011-11-24 11:53:49 +0100 | [diff] [blame] | 47 | * |
| 48 | * The only required fields are N,K and the next_output/next_state arrays. The |
| 49 | * other can be left to default value of zero depending on what the code does. |
| 50 | * If 'len' is left at 0 then only the low level API can be used. |
| 51 | */ |
Sylvain Munaut | 19dc5c9 | 2011-04-23 16:09:19 +0200 | [diff] [blame] | 52 | struct osmo_conv_code { |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 53 | int N; /*!< Inverse of code rate */ |
| 54 | int K; /*!< Constraint length */ |
| 55 | int len; /*!< # of data bits */ |
Sylvain Munaut | 19dc5c9 | 2011-04-23 16:09:19 +0200 | [diff] [blame] | 56 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 57 | enum osmo_conv_term term; /*!< Termination type */ |
Sylvain Munaut | 297d13f | 2011-11-24 17:46:58 +0100 | [diff] [blame] | 58 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 59 | const uint8_t (*next_output)[2];/*!< Next output array */ |
| 60 | const uint8_t (*next_state)[2]; /*!< Next state array */ |
Sylvain Munaut | 19dc5c9 | 2011-04-23 16:09:19 +0200 | [diff] [blame] | 61 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 62 | const uint8_t *next_term_output;/*!< Flush termination output */ |
| 63 | const uint8_t *next_term_state; /*!< Flush termination state */ |
Sylvain Munaut | 19dc5c9 | 2011-04-23 16:09:19 +0200 | [diff] [blame] | 64 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 65 | const int *puncture; /*!< Punctured bits indexes */ |
Sylvain Munaut | 19dc5c9 | 2011-04-23 16:09:19 +0200 | [diff] [blame] | 66 | }; |
| 67 | |
| 68 | |
Sylvain Munaut | ae8dbb4 | 2011-11-24 17:47:32 +0100 | [diff] [blame] | 69 | /* Common */ |
| 70 | |
| 71 | int osmo_conv_get_input_length(const struct osmo_conv_code *code, int len); |
| 72 | int osmo_conv_get_output_length(const struct osmo_conv_code *code, int len); |
| 73 | |
| 74 | |
Sylvain Munaut | 19dc5c9 | 2011-04-23 16:09:19 +0200 | [diff] [blame] | 75 | /* Encoding */ |
| 76 | |
| 77 | /* Low level API */ |
Sylvain Munaut | 03d2c89 | 2011-11-24 11:53:49 +0100 | [diff] [blame] | 78 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 79 | /*! convolutional encoder state */ |
Sylvain Munaut | 19dc5c9 | 2011-04-23 16:09:19 +0200 | [diff] [blame] | 80 | struct osmo_conv_encoder { |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 81 | const struct osmo_conv_code *code; /*!< for which code? */ |
| 82 | int i_idx; /*!< Next input bit index */ |
| 83 | int p_idx; /*!< Current puncture index */ |
| 84 | uint8_t state; /*!< Current state */ |
Sylvain Munaut | 19dc5c9 | 2011-04-23 16:09:19 +0200 | [diff] [blame] | 85 | }; |
| 86 | |
| 87 | void osmo_conv_encode_init(struct osmo_conv_encoder *encoder, |
| 88 | const struct osmo_conv_code *code); |
Sylvain Munaut | 297d13f | 2011-11-24 17:46:58 +0100 | [diff] [blame] | 89 | void osmo_conv_encode_load_state(struct osmo_conv_encoder *encoder, |
| 90 | const ubit_t *input); |
Sylvain Munaut | 19dc5c9 | 2011-04-23 16:09:19 +0200 | [diff] [blame] | 91 | int osmo_conv_encode_raw(struct osmo_conv_encoder *encoder, |
| 92 | const ubit_t *input, ubit_t *output, int n); |
Sylvain Munaut | 297d13f | 2011-11-24 17:46:58 +0100 | [diff] [blame] | 93 | int osmo_conv_encode_flush(struct osmo_conv_encoder *encoder, ubit_t *output); |
Sylvain Munaut | 19dc5c9 | 2011-04-23 16:09:19 +0200 | [diff] [blame] | 94 | |
| 95 | /* All-in-one */ |
| 96 | int osmo_conv_encode(const struct osmo_conv_code *code, |
| 97 | const ubit_t *input, ubit_t *output); |
| 98 | |
| 99 | |
| 100 | /* Decoding */ |
| 101 | |
| 102 | /* Low level API */ |
Sylvain Munaut | 03d2c89 | 2011-11-24 11:53:49 +0100 | [diff] [blame] | 103 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 104 | /*! convolutional decoder state */ |
Sylvain Munaut | 19dc5c9 | 2011-04-23 16:09:19 +0200 | [diff] [blame] | 105 | struct osmo_conv_decoder { |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 106 | const struct osmo_conv_code *code; /*!< for which code? */ |
Sylvain Munaut | 19dc5c9 | 2011-04-23 16:09:19 +0200 | [diff] [blame] | 107 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 108 | int n_states; /*!< number of states */ |
Sylvain Munaut | 19dc5c9 | 2011-04-23 16:09:19 +0200 | [diff] [blame] | 109 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 110 | int len; /*!< Max o_idx (excl. termination) */ |
Sylvain Munaut | 19dc5c9 | 2011-04-23 16:09:19 +0200 | [diff] [blame] | 111 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 112 | int o_idx; /*!< output index */ |
| 113 | int p_idx; /*!< puncture index */ |
Sylvain Munaut | 19dc5c9 | 2011-04-23 16:09:19 +0200 | [diff] [blame] | 114 | |
Neels Hofmeyr | 87e4550 | 2017-06-20 00:17:59 +0200 | [diff] [blame] | 115 | unsigned int *ae; /*!< accumulated error */ |
| 116 | unsigned int *ae_next; /*!< next accumulated error (tmp in scan) */ |
| 117 | uint8_t *state_history; /*!< state history [len][n_states] */ |
Sylvain Munaut | 19dc5c9 | 2011-04-23 16:09:19 +0200 | [diff] [blame] | 118 | }; |
| 119 | |
| 120 | void osmo_conv_decode_init(struct osmo_conv_decoder *decoder, |
Sylvain Munaut | 297d13f | 2011-11-24 17:46:58 +0100 | [diff] [blame] | 121 | const struct osmo_conv_code *code, |
| 122 | int len, int start_state); |
| 123 | void osmo_conv_decode_reset(struct osmo_conv_decoder *decoder, int start_state); |
| 124 | void osmo_conv_decode_rewind(struct osmo_conv_decoder *decoder); |
Sylvain Munaut | 19dc5c9 | 2011-04-23 16:09:19 +0200 | [diff] [blame] | 125 | void osmo_conv_decode_deinit(struct osmo_conv_decoder *decoder); |
| 126 | |
| 127 | int osmo_conv_decode_scan(struct osmo_conv_decoder *decoder, |
| 128 | const sbit_t *input, int n); |
Sylvain Munaut | 297d13f | 2011-11-24 17:46:58 +0100 | [diff] [blame] | 129 | int osmo_conv_decode_flush(struct osmo_conv_decoder *decoder, |
| 130 | const sbit_t *input); |
Sylvain Munaut | 19dc5c9 | 2011-04-23 16:09:19 +0200 | [diff] [blame] | 131 | int osmo_conv_decode_get_output(struct osmo_conv_decoder *decoder, |
Sylvain Munaut | 297d13f | 2011-11-24 17:46:58 +0100 | [diff] [blame] | 132 | ubit_t *output, int has_flush, int end_state); |
Sylvain Munaut | 19dc5c9 | 2011-04-23 16:09:19 +0200 | [diff] [blame] | 133 | |
| 134 | /* All-in-one */ |
| 135 | int osmo_conv_decode(const struct osmo_conv_code *code, |
| 136 | const sbit_t *input, ubit_t *output); |
| 137 | |
| 138 | |
Sylvain Munaut | dca7d2c | 2012-04-18 21:53:23 +0200 | [diff] [blame] | 139 | /*! @} */ |