mirror of
https://github.com/DJ2LS/FreeDATA
synced 2024-05-14 08:04:33 +00:00
Tweak README again.
This commit is contained in:
parent
ce757ec38a
commit
e579a39fc3
1 changed files with 21 additions and 21 deletions
42
README.md
42
README.md
|
@ -30,45 +30,45 @@ Download the latest developer release from the releases section, unpack it and j
|
||||||
## Installation
|
## Installation
|
||||||
Please check the [wiki](https://wiki.freedata.app) for installation instructions
|
Please check the [wiki](https://wiki.freedata.app) for installation instructions
|
||||||
|
|
||||||
## Code Unit Tests
|
## Unit Tests
|
||||||
The following tests cover some TNC functionality and the interface to codec2:
|
The following tests cover some TNC functionality and the interface to codec2:
|
||||||
1. Name: audio_buffer
|
1. Name: `audio_buffer`
|
||||||
Tests the thread safety of the audio buffer routines.
|
Tests the thread safety of the audio buffer routines.
|
||||||
1. Name: resampler
|
1. Name: `resampler`
|
||||||
Tests FreeDATA audio resampling from 48KHz to 8KHz.
|
Tests FreeDATA audio resampling from 48KHz to 8KHz.
|
||||||
1. Name: tnc_state_machine
|
1. Name: `tnc_state_machine`
|
||||||
Tests TNC transitions between states.
|
Tests TNC transitions between states.
|
||||||
1. Name: helper_routines
|
1. Name: `helper_routines`
|
||||||
Tests various helper routines.
|
Tests various helper routines.
|
||||||
1. Name: py_highsnr_stdio_P_P_multi
|
1. Name: `py_highsnr_stdio_P_P_multi`
|
||||||
Tests a high signal-to-noise ratio (good quality) audio path using multiple codecs. (Pure python.)
|
Tests a high signal-to-noise ratio (good quality) audio path using multiple codecs. (Pure python.)
|
||||||
1. Name: py_highsnr_stdio_P_P_datacx
|
1. Name: `py_highsnr_stdio_P_P_datacx`
|
||||||
Tests a high signal-to-noise ratio audio path using multiple individual codecs.
|
Tests a high signal-to-noise ratio audio path using multiple individual codecs.
|
||||||
1. Name: py_highsnr_stdio_P_C_datacx
|
1. Name: `py_highsnr_stdio_P_C_datacx`
|
||||||
Tests a high signal-to-noise ratio audio path using multiple individual codecs.
|
Tests a high signal-to-noise ratio audio path using multiple individual codecs.
|
||||||
1. Name: py_highsnr_stdio_C_P_datacx
|
1. Name: `py_highsnr_stdio_C_P_datacx`
|
||||||
Tests a high signal-to-noise ratio audio path using multiple individual codecs.
|
Tests a high signal-to-noise ratio audio path using multiple individual codecs.
|
||||||
1. Name: highsnr_stdio_P_C_single
|
1. Name: `highsnr_stdio_P_C_single`
|
||||||
Tests compatibility with FreeDATA's transmit and freedv's raw data receive.
|
Tests compatibility with FreeDATA's transmit and freedv's raw data receive.
|
||||||
1. Name: highsnr_stdio_C_P_single
|
1. Name: `highsnr_stdio_C_P_single`
|
||||||
Tests compatibility with freedv's raw data transmit and FreeDATA's receive.
|
Tests compatibility with freedv's raw data transmit and FreeDATA's receive.
|
||||||
1. Name: highsnr_stdio_P_P_single
|
1. Name: `highsnr_stdio_P_P_single`
|
||||||
Tests a high signal-to-noise ratio audio path using multiple codecs. (Requires POSIX system.)
|
Tests a high signal-to-noise ratio audio path using multiple codecs. (Requires POSIX system.)
|
||||||
1. Name: highsnr_stdio_P_P_multi
|
1. Name: `highsnr_stdio_P_P_multi`
|
||||||
Tests a high signal-to-noise ratio audio path using multiple codecs. (Requires POSIX system.)
|
Tests a high signal-to-noise ratio audio path using multiple codecs. (Requires POSIX system.)
|
||||||
|
|
||||||
The following tests can not currently be run with Github's pipeline as they require the ALSA dummy device
|
The following tests can not currently be run with Github's pipeline as they require the ALSA dummy device
|
||||||
kernel module to be installed. They also do not perform reliably. These tests are slowly being
|
kernel module to be installed. They also do not perform reliably. These tests are slowly being
|
||||||
replaced with equivalent pipeline-compatible tests.
|
replaced with equivalent pipeline-compatible tests.
|
||||||
1. Name: highsnr_virtual1_P_P_single_alsa
|
1. Name: `highsnr_virtual1_P_P_single_alsa`
|
||||||
Tests a high signal-to-noise ratio audio path using a single codec directly over an ALSA dummy device.
|
Tests a high signal-to-noise ratio audio path using a single codec directly over an ALSA dummy device.
|
||||||
1. Name: highsnr_virtual2_P_P_single
|
1. Name: `highsnr_virtual2_P_P_single`
|
||||||
Tests a high signal-to-noise ratio audio path using a single codec over an ALSA dummy device.
|
Tests a high signal-to-noise ratio audio path using a single codec over an ALSA dummy device.
|
||||||
1. Name: highsnr_virtual3_P_P_multi
|
1. Name: `highsnr_virtual3_P_P_multi`
|
||||||
Tests a high signal-to-noise ratio audio path using multiple codecs over an ALSA dummy device.
|
Tests a high signal-to-noise ratio audio path using multiple codecs over an ALSA dummy device.
|
||||||
1. Name: highsnr_virtual4_P_P_single_callback
|
1. Name: `highsnr_virtual4_P_P_single_callback`
|
||||||
1. Name: highsnr_virtual4_P_P_single_callback_outside
|
1. Name: `highsnr_virtual4_P_P_single_callback_outside`
|
||||||
1. Name: highsnr_virtual5_P_P_multi_callback
|
1. Name: `highsnr_virtual5_P_P_multi_callback`
|
||||||
1. Name: highsnr_virtual5_P_P_multi_callback_outside
|
1. Name: `highsnr_virtual5_P_P_multi_callback_outside`
|
||||||
1. Name: highsnr_ARQ_short
|
1. Name: `highsnr_ARQ_short`
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue