FreeCalypso > hg > gsm-codec-lib
changeset 635:723265aea9f8
doc/HR-codec-library: finish library documentation
| author | Mychaela Falconia <falcon@freecalypso.org> |
|---|---|
| date | Fri, 20 Mar 2026 04:27:04 +0000 |
| parents | 4c5a4fcf9236 |
| children | 76c6fa603370 |
| files | doc/HR-codec-library |
| diffstat | 1 files changed, 22 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/doc/HR-codec-library Fri Mar 20 03:58:33 2026 +0000 +++ b/doc/HR-codec-library Fri Mar 20 04:27:04 2026 +0000 @@ -418,3 +418,25 @@ frame into a SID frame with the same R0 and LPC parameters. It is logically equivalent to gsmhr_ts101318_set_sid_codeword(), but operates on the array of parameters form, rather than TS 101 318 packed format. + +Public constant definitions +=========================== + +Our public header file <tw_gsmhr.h> provides these constant definitions, which +should be self-explanatory: + +#define GSMHR_NUM_PARAMS 18 /* actual codec parameters */ +#define GSMHR_NUM_PARAMS_ENC 20 /* output from the encoder */ +#define GSMHR_NUM_PARAMS_DEC 22 /* input to the decoder */ + +#define GSMHR_FRAME_LEN_RPF 14 /* raw packed format */ +#define GSMHR_FRAME_LEN_5993 15 /* RFC 5993 and TW-TS-002 */ + +Public const data items +======================= + +The spec-defined decoder homing frame for GSM-HR is provided in both native +(array of parameters) and packed (TS 101 318) formats: + +extern const int16_t gsmhr_dhf_params[GSMHR_NUM_PARAMS]; +extern const uint8_t gsmhr_dhf_ts101318[GSMHR_FRAME_LEN_RPF];
