FreeCalypso > hg > gsm-codec-lib

comparison doc/FR1-library-API @ 299:59751c8fc773

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc/FR1-library-API: finish in first pass
author Mychaela Falconia <falcon@freecalypso.org>
date Mon, 15 Apr 2024 18:04:02 +0000
parents a45f806cada9
children
comparison
equal deleted inserted replaced
298:a45f806cada9 299:59751c8fc773
248 This function analyzes an RTP-encoded FR frame (the upper nibble of the first 248 This function analyzes an RTP-encoded FR frame (the upper nibble of the first
249 byte is NOT checked for 0xD signature) for the SID codeword of GSM 06.12 and 249 byte is NOT checked for 0xD signature) for the SID codeword of GSM 06.12 and
250 classifies the frame as SID=0, SID=1 or SID=2 per the rules of GSM 06.31 250 classifies the frame as SID=0, SID=1 or SID=2 per the rules of GSM 06.31
251 section 6.1.1. This classification is the first processing step performed by 251 section 6.1.1. This classification is the first processing step performed by
252 gsmfr_preproc_good_frame(). 252 gsmfr_preproc_good_frame().
253
254 Public constant definitions
255 ===========================
256
257 Our public header file <tw_gsmfr.h> provides these constant definitions, which
258 should be self-explanatory:
259
260 #define GSMFR_RTP_FRAME_LEN 33
261 #define GSMFR_NUM_PARAMS 76
262
263 Public const data items
264 =======================
265
266 There are two special GSM-FR frame bit patterns defined in the specs: there is
267 the silence frame of GSM 06.11, and there is the decoder homing frame specified
268 in later versions of GSM 06.10. RTP-packed representations of both frames are
269 included in libgsmfr2, and are made public:
270
271 extern const uint8_t gsmfr_preproc_silence_frame[GSMFR_RTP_FRAME_LEN];
272 extern const uint8_t gsmfr_decoder_homing_frame[GSMFR_RTP_FRAME_LEN];