annotate README @ 6:9cbb19619a9f default tip

README: punctuation fix
author Mychaela Falconia <falcon@freecalypso.org>
date Tue, 20 Aug 2024 19:00:23 +0000
parents a2529fec5442
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
a2529fec5442 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
1 This Hg repository contains a mostly-raw import of GSM-HR speech codec
a2529fec5442 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
2 implementation from the original GSM 06.06 publication. The only modification
a2529fec5442 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
3 that has been made is a minimally-invasive surgical change to gsm_hr.c (the
a2529fec5442 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
4 main module) that allows the default noisy output to be suppressed at run time,
a2529fec5442 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
5 rather than at compile time, and suppresses all of this noisy output rather
a2529fec5442 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
6 than just one part of it. Also a Makefile has been added, for straightforward
a2529fec5442 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
7 compilation on "semi-modern" systems such as Slackware Linux.
a2529fec5442 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
8
a2529fec5442 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
9 This work has been produced for two purposes:
a2529fec5442 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
10
a2529fec5442 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
11 1) To make it possible to actually run this original GSM-HR code, before the
a2529fec5442 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
12 laborious effort of librifying it and incorporating it into gsm-codec-lib,
6
9cbb19619a9f README: punctuation fix
Mychaela Falconia <falcon@freecalypso.org>
parents: 4
diff changeset
13 and for verification, testing and comparison after that planned work.
4
a2529fec5442 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
14
a2529fec5442 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
15 2) To have the code readily available in a public Hg repository, allowing
a2529fec5442 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
16 direct links to individual files or even to line numbers. Such easy linking
a2529fec5442 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
17 ability is needed to facilitate analysis and discussion of various aspects
a2529fec5442 add README
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff changeset
18 of this reference code.