Skip to content

Commit 426bff9

Browse files
committed
Add table explaining the demo programs.
1 parent 8006925 commit 426bff9

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README_freedv.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,16 +83,29 @@ The FSK_LDPC mode is used for data, and has user defined bit rate and a variety
8383
## FreeDV API
8484

8585
The `codec2/demo` directory provides simple FreeDV API demo programs written in C and Python to help you get started, for example:
86+
8687
```
8788
cd codec2/build_linux
8889
cat ../raw/ve9qrp_10s.raw | ./demo/freedv_700d_tx | ./demo/freedv_700d_rx | aplay -f S16_LE
8990
```
9091

92+
The current demo programs are as follows:
93+
94+
| Program | Description |
95+
| --- | --- |
96+
| c2demo | Demonstrates usage of the codec2_* function calls. |
97+
| freedv_700d_rx | Demonstrates how to receive a FreeDV voice signal. |
98+
| freedv_700d_tx | Demonstrates how to transmit a FreeDV voice signal. |
99+
| freedv_datac1_rx | Demonstrates how to receive a FreeDV data signal. |
100+
| freedv_datac1_tx | Demonstrates how to transmit a FreeDV data signal. |
101+
91102
See also [freedv_api.h](src/freedv_api.h) and [freedv_api.c](src/freedv_api.c), and the full featured command line demo programs [freedv_tx.c](src/freedv_tx.c) & [freedv_rx.c](src/freedv_rx.c):
103+
92104
```
93105
$ ./freedv_tx 1600 ../../raw/hts1.raw - | ./freedv_rx 1600 - - | aplay -f S16_LE
94106
$ cat freedv_rx_log.txt
95107
```
108+
96109
## FreeDV 2400A and 2400B modes
97110

98111
FreeDV 2400A and FreeDV 2400B are modes designed for VHF radio. FreeDV 2400A is designed for SDR radios (it has a 5 kHz RF bandwidth), however FreeDV 2400B is designed to pass through commodity FM radios.

0 commit comments

Comments
 (0)