annotate CHANGES @ 476:c84bf526c7eb

beginning of libtwamr documentation
author Mychaela Falconia <falcon@freecalypso.org>
date Sat, 18 May 2024 21:22:07 +0000
parents 2d46abdfbe91
children 20d44cfc219c
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
452
6e595f7d40e2 CHANGES: document changes for the upcoming release
Mychaela Falconia <falcon@freecalypso.org>
parents: 251
diff changeset
1 Changes from gsm-codec-lib-r2 to gsm-codec-lib-r3:
6e595f7d40e2 CHANGES: document changes for the upcoming release
Mychaela Falconia <falcon@freecalypso.org>
parents: 251
diff changeset
2
6e595f7d40e2 CHANGES: document changes for the upcoming release
Mychaela Falconia <falcon@freecalypso.org>
parents: 251
diff changeset
3 * Libgsmfrp has been replaced with libgsmfr2, a major version change per SemVer.
6e595f7d40e2 CHANGES: document changes for the upcoming release
Mychaela Falconia <falcon@freecalypso.org>
parents: 251
diff changeset
4
6e595f7d40e2 CHANGES: document changes for the upcoming release
Mychaela Falconia <falcon@freecalypso.org>
parents: 251
diff changeset
5 * The former dependency on historical libgsm has been eliminated; the
6e595f7d40e2 CHANGES: document changes for the upcoming release
Mychaela Falconia <falcon@freecalypso.org>
parents: 251
diff changeset
6 functionality of libgsm (GSM 06.10 encoder and decoder implementation) has
6e595f7d40e2 CHANGES: document changes for the upcoming release
Mychaela Falconia <falcon@freecalypso.org>
parents: 251
diff changeset
7 been absorbed into libgsmfr2.
6e595f7d40e2 CHANGES: document changes for the upcoming release
Mychaela Falconia <falcon@freecalypso.org>
parents: 251
diff changeset
8
473
2d46abdfbe91 libgsmefr version 1.1.0 for DHF addition
Mychaela Falconia <falcon@freecalypso.org>
parents: 462
diff changeset
9 * Libgsmefr version 1.1.0 exhibits approximately 2x performance improvement
2d46abdfbe91 libgsmefr version 1.1.0 for DHF addition
Mychaela Falconia <falcon@freecalypso.org>
parents: 462
diff changeset
10 over the original version, and also exhibits a small addition to the public
2d46abdfbe91 libgsmefr version 1.1.0 for DHF addition
Mychaela Falconia <falcon@freecalypso.org>
parents: 462
diff changeset
11 API: the RTP-encoded form of the standard EFR DHF is now provided as a const
2d46abdfbe91 libgsmefr version 1.1.0 for DHF addition
Mychaela Falconia <falcon@freecalypso.org>
parents: 462
diff changeset
12 datum.
452
6e595f7d40e2 CHANGES: document changes for the upcoming release
Mychaela Falconia <falcon@freecalypso.org>
parents: 251
diff changeset
13
6e595f7d40e2 CHANGES: document changes for the upcoming release
Mychaela Falconia <falcon@freecalypso.org>
parents: 251
diff changeset
14 * New library added: libtwamr for 3GPP AMR-NB codec, serving as a replacement
6e595f7d40e2 CHANGES: document changes for the upcoming release
Mychaela Falconia <falcon@freecalypso.org>
parents: 251
diff changeset
15 for libopencore-amrnb in Themyscira GSM codec exploration workflows.
6e595f7d40e2 CHANGES: document changes for the upcoming release
Mychaela Falconia <falcon@freecalypso.org>
parents: 251
diff changeset
16
6e595f7d40e2 CHANGES: document changes for the upcoming release
Mychaela Falconia <falcon@freecalypso.org>
parents: 251
diff changeset
17 * New command line utilities: amrefr-* and twamr-* related to libtwamr,
6e595f7d40e2 CHANGES: document changes for the upcoming release
Mychaela Falconia <falcon@freecalypso.org>
parents: 251
diff changeset
18 gsmfr-* updates for libgsmfr2.
6e595f7d40e2 CHANGES: document changes for the upcoming release
Mychaela Falconia <falcon@freecalypso.org>
parents: 251
diff changeset
19
462
bada654a859b CHANGES: document rm of gsmfr-hand-test and gsmfr-max-out
Mychaela Falconia <falcon@freecalypso.org>
parents: 455
diff changeset
20 * gsmfr-* utilities set: gsmfr-hand-test and gsmfr-max-out hack programs have
bada654a859b CHANGES: document rm of gsmfr-hand-test and gsmfr-max-out
Mychaela Falconia <falcon@freecalypso.org>
parents: 455
diff changeset
21 been dropped. These hack programs were never properly documented and were
bada654a859b CHANGES: document rm of gsmfr-hand-test and gsmfr-max-out
Mychaela Falconia <falcon@freecalypso.org>
parents: 455
diff changeset
22 written only as part of a debug chase, in pursuit of a bug that ultimately
bada654a859b CHANGES: document rm of gsmfr-hand-test and gsmfr-max-out
Mychaela Falconia <falcon@freecalypso.org>
parents: 455
diff changeset
23 turned out to be in our then-hacky patch to osmo-bts-sysmo.
bada654a859b CHANGES: document rm of gsmfr-hand-test and gsmfr-max-out
Mychaela Falconia <falcon@freecalypso.org>
parents: 455
diff changeset
24
455
287063b9cf43 CHANGES: document the build process change
Mychaela Falconia <falcon@freecalypso.org>
parents: 452
diff changeset
25 * The configuration and build process has been revamped: the full suite of
287063b9cf43 CHANGES: document the build process change
Mychaela Falconia <falcon@freecalypso.org>
parents: 452
diff changeset
26 libraries and utilities can now be installed in any desired file system
287063b9cf43 CHANGES: document the build process change
Mychaela Falconia <falcon@freecalypso.org>
parents: 452
diff changeset
27 location without contortions.
287063b9cf43 CHANGES: document the build process change
Mychaela Falconia <falcon@freecalypso.org>
parents: 452
diff changeset
28
251
946849291027 CHANGES: document changes since gsm-codec-lib-r1
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
29 Changes from gsm-codec-lib-r1 to gsm-codec-lib-r2:
946849291027 CHANGES: document changes since gsm-codec-lib-r1
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
30
946849291027 CHANGES: document changes since gsm-codec-lib-r1
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
31 * Libgsmfrp evolved from version 1.0.0 to version 1.0.2; please see
946849291027 CHANGES: document changes since gsm-codec-lib-r1
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
32 doc/FR1-Rx-DTX for a detailing listing of libgsmfrp changes.
946849291027 CHANGES: document changes since gsm-codec-lib-r1
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
33
946849291027 CHANGES: document changes since gsm-codec-lib-r1
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
34 * Some new utilities have been developed for studying AMR: see
946849291027 CHANGES: document changes since gsm-codec-lib-r1
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
35 doc/AMR-study-utils for more information.
946849291027 CHANGES: document changes since gsm-codec-lib-r1
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
36
946849291027 CHANGES: document changes since gsm-codec-lib-r1
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
37 * The subject of conversions between 16-bit 2's complement linear PCM and 8-bit
946849291027 CHANGES: document changes since gsm-codec-lib-r1
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
38 A-law and mu-law PCM formats (G.711) has been thoroughly studied, the findings
946849291027 CHANGES: document changes since gsm-codec-lib-r1
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
39 have been documented in doc/PCM8-conversions, and some new command line
946849291027 CHANGES: document changes since gsm-codec-lib-r1
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
40 utilities have been added, described in the same article.
946849291027 CHANGES: document changes since gsm-codec-lib-r1
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
41
946849291027 CHANGES: document changes since gsm-codec-lib-r1
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
42 * Many new table generators have been added to the dev subdirectory; some of
946849291027 CHANGES: document changes since gsm-codec-lib-r1
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
43 them may be useful to other software developers.
946849291027 CHANGES: document changes since gsm-codec-lib-r1
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
44
946849291027 CHANGES: document changes since gsm-codec-lib-r1
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
45 * pcap utilities have been split off to a separate rtp-debug-utils repository;
946849291027 CHANGES: document changes since gsm-codec-lib-r1
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
46 this split was made so that those utilities can be developed freely while the
946849291027 CHANGES: document changes since gsm-codec-lib-r1
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
47 gsm-codec-lib repository remains under strict release process control.