diff options
| author | drowe67 <[email protected]> | 2023-12-12 09:50:48 +1030 |
|---|---|---|
| committer | GitHub <[email protected]> | 2023-12-12 09:50:48 +1030 |
| commit | 93dbb6290495ccb194759506372b72fac1b1b104 (patch) | |
| tree | c7a57ab014674259999feb3b2eba0dd004a5f664 /README.md | |
| parent | 4f4f7304542c4c3ef49d443ae78732b0e6683a0f (diff) | |
| parent | b8e452709330c75abfab55919575966da3bb030c (diff) | |
Merge pull request #31 from drowe67/dr-codec2-doc
WP2000 - Codec 2 Algorithm Description
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 7 |
1 files changed, 6 insertions, 1 deletions
@@ -110,6 +110,10 @@ We have standardized on C99 and develop and test using gcc on a Linux platform. make ``` +## Documentation + +An algorithm description can be found in `doc/codec2.pdf`. + ## Programs + See `demo` directory for simple examples of using Codec and the FreeDV API. @@ -138,7 +142,7 @@ CTest is used as a test framework, with support from [GNU Octave](https://www.gn 1. Install GNU Octave and libraries on Ubuntu with: ``` - sudo apt install octave octave-common octave-signal liboctave-dev gnuplot python3-numpy sox valgrind clang-format + sudo apt install octave octave-common octave-signal liboctave-dev gnuplot python3-numpy sox valgrind clang-format texmaker texlive-bibtex-extra texlive-science ``` 1. To build and run the tests: ``` @@ -180,6 +184,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 +doc - documentation 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) |