FreeCalypso > hg > gsm-codec-lib

comparison doc/HR-codec-library @ 635:723265aea9f8

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc/HR-codec-library: finish library documentation
author Mychaela Falconia <falcon@freecalypso.org>
date Fri, 20 Mar 2026 04:27:04 +0000
parents 3ab76caba41c
children
comparison
equal deleted inserted replaced
634:4c5a4fcf9236 635:723265aea9f8
416 This function fills parameters 4 through 17 of generated SID frames, setting 416 This function fills parameters 4 through 17 of generated SID frames, setting
417 them to the required SID codeword. It can also be used to transform a speech 417 them to the required SID codeword. It can also be used to transform a speech
418 frame into a SID frame with the same R0 and LPC parameters. It is logically 418 frame into a SID frame with the same R0 and LPC parameters. It is logically
419 equivalent to gsmhr_ts101318_set_sid_codeword(), but operates on the array of 419 equivalent to gsmhr_ts101318_set_sid_codeword(), but operates on the array of
420 parameters form, rather than TS 101 318 packed format. 420 parameters form, rather than TS 101 318 packed format.
421
422 Public constant definitions
423 ===========================
424
425 Our public header file <tw_gsmhr.h> provides these constant definitions, which
426 should be self-explanatory:
427
428 #define GSMHR_NUM_PARAMS 18 /* actual codec parameters */
429 #define GSMHR_NUM_PARAMS_ENC 20 /* output from the encoder */
430 #define GSMHR_NUM_PARAMS_DEC 22 /* input to the decoder */
431
432 #define GSMHR_FRAME_LEN_RPF 14 /* raw packed format */
433 #define GSMHR_FRAME_LEN_5993 15 /* RFC 5993 and TW-TS-002 */
434
435 Public const data items
436 =======================
437
438 The spec-defined decoder homing frame for GSM-HR is provided in both native
439 (array of parameters) and packed (TS 101 318) formats:
440
441 extern const int16_t gsmhr_dhf_params[GSMHR_NUM_PARAMS];
442 extern const uint8_t gsmhr_dhf_ts101318[GSMHR_FRAME_LEN_RPF];