diff doc/FR1-library-history @ 534:516e84085a15

libgsmfr2 is now at version 2.1.0
author Mychaela Falconia <falcon@freecalypso.org>
date Fri, 20 Sep 2024 00:17:35 +0000
parents 019eed8b1948
children
line wrap: on
line diff
--- a/doc/FR1-library-history	Thu Sep 19 21:58:10 2024 +0000
+++ b/doc/FR1-library-history	Fri Sep 20 00:17:35 2024 +0000
@@ -3,6 +3,28 @@
 supplants the earlier combination of libgsm+libgsmfrp.  This document details
 the change history in this continuum of GSM-FR codec libraries.
 
+libgsmfr2 change history: version 2.0.0 to version 2.1.0
+========================================================
+
+* New functions gsmfr_{preproc,fulldec}_bfi_bits() handle the case of received
+  BFI with payload bits included.  GSM 06.31 requires that the combination of
+  BFI with "accepted SID frame" bit pattern be treated as an invalid SID frame,
+  not as an unusable frame; this requirement could not be fulfilled with the
+  previous gsmfr_{preproc,fulldec}_bfi() API that only does unusable frame
+  handling.
+
+* Several new API functions were added that facilitate the use of our Rx DTX
+  preprocessor block as a TFO transform, including the possibility of DTXd.
+
+* Convenience wrapper functions were added for both the full decoder and the
+  TFO transform that take RTP input (payload bytes and length), encapsulating
+  the logic of TW-TS-001 for both basic and extended RTP formats.
+
+* Sizes of internal state structures are exported as public const "variables"
+  (const memory words really), allowing alternative methods of allocating memory
+  for these structs besides the standard malloc-calling gsmfr_*_create()
+  functions.
+
 Changes from libgsmfrp version 1.0.2 to libgsmfr2 version 2.0.0
 ===============================================================