From ce757ec38adb9b8b67e99d626ab595da4fac8456 Mon Sep 17 00:00:00 2001 From: Paul Kronenwetter Date: Sat, 7 May 2022 17:48:19 -0400 Subject: [PATCH] Update README with new tests. --- README.md | 40 ++++++++++++++++++++++------------------ 1 file changed, 22 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 6fafabb1..52f27b5e 100644 --- a/README.md +++ b/README.md @@ -34,37 +34,41 @@ Please check the [wiki](https://wiki.freedata.app) for installation instructions The following tests cover some TNC functionality and the interface to codec2: 1. Name: audio_buffer Tests the thread safety of the audio buffer routines. -2. Name: resampler +1. Name: resampler Tests FreeDATA audio resampling from 48KHz to 8KHz. -3. Name: tnc_state_machine +1. Name: tnc_state_machine Tests TNC transitions between states. -4. Name: helper_routines +1. Name: helper_routines Tests various helper routines. -5. 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.) -6. Name: py_highsnr_stdio_P_P_datacx - Tests a high signal-to-noise ratio audio path using multiple individual codecs. (Pure python.) -7. Name: highsnr_stdio_P_C_single +1. Name: py_highsnr_stdio_P_P_datacx + Tests a high signal-to-noise ratio audio path using multiple individual codecs. +1. Name: py_highsnr_stdio_P_C_datacx + Tests a high signal-to-noise ratio audio path using multiple individual codecs. +1. Name: py_highsnr_stdio_C_P_datacx + Tests a high signal-to-noise ratio audio path using multiple individual codecs. +1. Name: highsnr_stdio_P_C_single Tests compatibility with FreeDATA's transmit and freedv's raw data receive. -8. 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. -9. 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.) -10. 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.) 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 replaced with equivalent pipeline-compatible tests. -11. 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. -12. 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. -13. 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. -14. Name: highsnr_virtual4_P_P_single_callback -15. Name: highsnr_virtual4_P_P_single_callback_outside -16. Name: highsnr_virtual5_P_P_multi_callback -17. Name: highsnr_virtual5_P_P_multi_callback_outside -18. Name: highsnr_ARQ_short +1. Name: highsnr_virtual4_P_P_single_callback +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_outside +1. Name: highsnr_ARQ_short