aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authordrowe67 <[email protected]>2023-07-14 10:33:23 +0930
committerGitHub <[email protected]>2023-07-14 10:33:23 +0930
commit6588e77f38bdebd7adffe091b22e7760d95d0ccb (patch)
treee015b6d01db10ff219f5d1cf49eb3dcadb7dbe48 /README.md
parentac7c48b4dee99d4c772f133d70d8d1b38262fcd2 (diff)
parent98992bc3585124981450659394d6f84032b81370 (diff)
Merge pull request #1 from drowe67/dr-cleanup
Cleanup
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 7 insertions, 18 deletions
diff --git a/README.md b/README.md
index 097a4de..0785a5e 100644
--- a/README.md
+++ b/README.md
@@ -5,12 +5,13 @@ Codec 2 is an open source (LGPL 2.1) low bit rate speech codec: http://rowetel.c
Also included:
+ The FreeDV API for digital voice over radio. FreeDV is an open source digital voice protocol that integrates modems, codecs, and FEC [README_freedv](README_freedv.md)
- + APIs for raw and Ethernet packet data over radio [README_data](README_data.md)
- + High performance coherent OFDM modem for HF channels [README_ofdm](README_ofdm.md)
- + High performance non-coherent FSK modem [README_fsk](README_fsk.md)
+ + HF OFDM and FSK modems, FEC used in the FreeDV API
+ + APIs for packet data over radio [README_data](README_data.md)
+ An STM32 embedded version of FreeDV 1600/700D/700E for the [SM1000](stm32/README.md)
- + Coherent PSK modem [README_cohpsk](README_cohpsk.md) for HF channels
- + FDMDV DPSK modem [README_fdmdv](README_fdmdv.md) for HF channels
+
+## Older code
+
+In July 2023 this repo was refactored, older code can be found in https://github.com/drowe67/codec2-dev
## Quickstart
@@ -154,10 +155,7 @@ CTest is used as a test framework, with support from [GNU Octave](https://www.gn
```
cmake - cmake support files
demo - Simple Codec 2 and FreeDv API demo applications
-misc - misc C programs that have been useful in development,
- not reqd for Codec 2 release. Part of Debug build.
-octave - Octave scripts used to support development
-script - shell scripts for playing and converting raw files
+octave - Octave scripts used to support ctests
src - C source code for Codec 2, FDMDV modem, COHPSK modem, FreeDV API
raw - speech files in raw format (16 bits signed linear 8 kHz)
stm32 - STM32F4 microcontroller and SM1000 FreeDV Adaptor support
@@ -175,15 +173,6 @@ wav - speech files in wave file format
make
```
-1. For dump file support (dump data from c2sim for input to Octave development scripts):
- ```
- cd ~/codec2
- rm -Rf build_linux && mkdir build_linux
- cd build_linux
- CFLAGS=-DDUMP cmake ..
- make
- ```
-
## Building for Windows on a Linux machine
We recommend using Linux to cross compile for Windows.