FreeCalypso > hg > gsm-codec-lib
annotate WIP:gsmhr @ 544:bd32bb1e8dab
doc/EFR-library-API: document malloc-alternative provision
author | Mychaela Falconia <falcon@freecalypso.org> |
---|---|
date | Thu, 03 Oct 2024 08:22:41 +0000 |
parents | b7ddcb178ef6 |
children |
rev | line source |
---|---|
509
b7ddcb178ef6
add WIP:gsmhr note file
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
1 The present state of gsm-codec-lib Hg repository is a Work In Progress |
b7ddcb178ef6
add WIP:gsmhr note file
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
2 with respect to addition of libgsmhr1, a WIP library seeking to implement |
b7ddcb178ef6
add WIP:gsmhr note file
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
3 GSM-HR codec in a way that fits into the grander vision of Themyscira Wireless. |
b7ddcb178ef6
add WIP:gsmhr note file
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
4 |
b7ddcb178ef6
add WIP:gsmhr note file
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
5 In the present WIP state absolutely NO commitments are being made with regard |
b7ddcb178ef6
add WIP:gsmhr note file
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
6 to API stability - the current WIP API can change at any moment! |
b7ddcb178ef6
add WIP:gsmhr note file
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
7 |
b7ddcb178ef6
add WIP:gsmhr note file
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
8 As a reminder, NO binary packages or build recipes should be made from this |
b7ddcb178ef6
add WIP:gsmhr note file
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
9 WIP state! If you don't need GSM-HR codec, please use the latest stable |
b7ddcb178ef6
add WIP:gsmhr note file
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
10 release tarball; if you do need GSM-HR codec, please wait until libgsmhr1 |
b7ddcb178ef6
add WIP:gsmhr note file
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
11 reaches version 1.0.0 per SemVer. |
b7ddcb178ef6
add WIP:gsmhr note file
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
12 |
b7ddcb178ef6
add WIP:gsmhr note file
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
13 If you need some GSM-HR functions (e.g., frame packing and unpacking) and |
b7ddcb178ef6
add WIP:gsmhr note file
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
14 cannot wait for libgsmhr1 version 1.0.0, the acceptable interim solution is to |
b7ddcb178ef6
add WIP:gsmhr note file
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
15 lift those individual C modules out of this repository and plop them directly |
b7ddcb178ef6
add WIP:gsmhr note file
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
16 into your own code - doing so would be more acceptable than making installable |
b7ddcb178ef6
add WIP:gsmhr note file
Mychaela Falconia <falcon@freecalypso.org>
parents:
diff
changeset
|
17 packages out of the present WIP. |