Add tests to verify lack of sync loss in RX

.github/workflows/cmake-linux.yml

@@ -15,33 +15,64 @@ jobs:
     # well on Windows or Mac.  You can convert this to a matrix build if you need
     # cross-platform coverage.
     # See: https://docs.github.com/en/free-pro-team@latest/actions/learn-github-actions/managing-complex-workflows#using-a-build-matrix
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
 
     - name: Install packages
       shell: bash
       run: |
            sudo apt-get update
-           sudo apt-get install codespell libpulse-dev libspeexdsp-dev libsamplerate0-dev sox git libwxgtk3.0-gtk3-dev portaudio19-dev libhamlib-dev libasound2-dev libao-dev libgsm1-dev libsndfile-dev python3-numpy
+           sudo apt-get upgrade -y
+           sudo apt-get install codespell libpulse-dev libspeexdsp-dev libsamplerate0-dev sox git libwxgtk3.2-dev portaudio19-dev libhamlib-dev libasound2-dev libao-dev libgsm1-dev libsndfile-dev xvfb pipewire pulseaudio-utils pipewire-pulse wireplumber metacity dbus-x11 at-spi2-core rtkit
 
     - name: Spellcheck codebase
       shell: bash
-      run: codespell --ignore-words-list=radae,rade,inout,nin,ontop,parm,tthe,ue `find src -name '*.c*' -o -name '*.h' -o -name '*.mm'`
+      run: codespell --ignore-words-list=caf,radae,rade,inout,nin,ontop,parm,tthe,ue `find src -name '*.c*' -o -name '*.h' -o -name '*.mm'`
+
+    - name: Install Python required modules
+      shell: bash
+      working-directory: ${{github.workspace}}
+      run: |
+          python3 -m venv rade-venv
+          . ./rade-venv/bin/activate
+          pip3 install torch torchaudio --index-url https://download.pytorch.org/whl/cpu
+          pip3 install matplotlib
 
     - name: Build freedv-gui using PortAudio
       shell: bash
       working-directory: ${{github.workspace}}
-      run: UT_ENABLE=1 ./build_linux.sh portaudio
+      run: |
+          . ./rade-venv/bin/activate
+          UT_ENABLE=1 ./build_linux.sh portaudio
 
     - name: Build freedv-gui using PulseAudio
       shell: bash
       working-directory: ${{github.workspace}}
-      run: UT_ENABLE=1 ./build_linux.sh pulseaudio
+      run: |
+          . ./rade-venv/bin/activate
+          UT_ENABLE=1 ./build_linux.sh pulseaudio
 
     - name: Execute unit tests
       shell: bash
       working-directory: ${{github.workspace}}/build_linux
-      run: make test
+      run: |
+          sudo systemctl enable rtkit-daemon
+          sudo systemctl start rtkit-daemon
+          Xvfb :99 -screen 0 1024x768x16 &
+          sleep 5
+          export DISPLAY=:99.0
+          export XDG_RUNTIME_DIR=/run/user/$(id -u)
+          mkdir -p $XDG_RUNTIME_DIR
+          chmod 700 $XDG_RUNTIME_DIR
+          eval "$(dbus-launch --sh-syntax --exit-with-x11)"
+          pipewire &
+          pipewire-pulse &
+          wireplumber &
+          metacity --sm-disable --replace &
+          sleep 5
+          ln -s ${{github.workspace}}/build_linux/rade_src/model19_check3 model19_check3
+          . ../rade-venv/bin/activate
+          PYTHONPATH=${{github.workspace}}/build_linux/rade_src:$PYTHONPATH ctest -V
 

.github/workflows/cmake-macos.yml

@@ -18,20 +18,31 @@ jobs:
     runs-on: macos-latest
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
 
     - name: Install packages
       shell: bash
       working-directory: ${{github.workspace}}
-      run: brew install automake libtool numpy
+      run: brew install automake libtool numpy sox
+
+    - name: Install virtual audio devices
+      shell: bash
+      working-directory: ${{github.workspace}}
+      run: ./build_macos_sound_drivers.sh
 
     - name: Build freedv-gui
       shell: bash
       working-directory: ${{github.workspace}}
       run: UT_ENABLE=1 ./build_osx.sh 
 
+    - name: Workaround macOS permission issues
+      run: |
+          sqlite3 $HOME/Library/Application\ Support/com.apple.TCC/TCC.db "INSERT OR IGNORE INTO access VALUES ('kTCCServiceMicrophone','/usr/local/opt/runner/provisioner/provisioner',1,2,4,1,NULL,NULL,0,'UNUSED',NULL,0,1687786159,NULL,NULL,'UNUSED',1687786159);"
+          sqlite3 $HOME/Library/Application\ Support/com.apple.TCC/TCC.db "INSERT OR IGNORE INTO access VALUES ('kTCCServiceMicrophone','/opt/off/opt/runner/provisioner/provisioner',1,2,4,1,NULL,NULL,0,'UNUSED',NULL,0,1687786159,NULL,NULL,'UNUSED',1687786159);"
+
     - name: Execute unit tests
       shell: bash
       working-directory: ${{github.workspace}}/build_osx
-      run: make test
-
+      run: |
+          FREEDV_COMPUTER_TO_RADIO_DEVICE="BlackHoleRadio 2ch" FREEDV_RADIO_TO_COMPUTER_DEVICE="BlackHoleRadio 2ch 2" FREEDV_COMPUTER_TO_SPEAKER_DEVICE="BlackHole1 2ch" FREEDV_MICROPHONE_TO_COMPUTER_DEVICE="BlackHole2 2ch" ctest -V
+

.github/workflows/cmake-windows.yml

@@ -18,7 +18,7 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
 
     - name: Install WINE
       run: |
@@ -48,6 +48,7 @@ jobs:
           export WINEPREFIX=`pwd`/wine-env
           wget https://www.python.org/ftp/python/3.12.7/python-3.12.7-amd64.exe
           Xvfb :99 -screen 0 1024x768x16 &
+          sleep 10
           export DISPLAY=:99.0
           wine ./python-3.12.7-amd64.exe /quiet /log c:\\python.log InstallAllUsers=1 Include_doc=0 Include_tcltk=0 || :
           cat $WINEPREFIX/drive_c/python.log
@@ -76,3 +77,105 @@ jobs:
       run: |
         export PATH=${{github.workspace}}/llvm-mingw-20230320-ucrt-ubuntu-18.04-x86_64/bin:$PATH
         make -j6 package
+
+    - name: Rename installer
+      shell: bash
+      working-directory: ${{github.workspace}}/build_windows
+      run: |
+        mv FreeDV*.exe FreeDV.exe
+
+    - name: Stash for next step
+      uses: actions/upload-artifact@v4
+      with:
+        name: FreeDVSetupProgram
+        path: ${{github.workspace}}/build_windows/FreeDV.exe
+
+  test:
+    runs-on: windows-latest
+    needs: build
+    env:
+      RADIO_TO_COMPUTER_DEVICE: "CABLE Output (VB-Audio Virtual Cable)"
+      COMPUTER_TO_RADIO_DEVICE: "Speakers (VB-Audio Virtual Cable)"
+      MICROPHONE_TO_COMPUTER_DEVICE: "Line 1 (Virtual Audio Cable)" 
+      COMPUTER_TO_SPEAKER_DEVICE: "Line 1 (Virtual Audio Cable)" 
+    steps: 
+    - uses: actions/checkout@v4
+    - uses: actions/download-artifact@v4
+      with:
+        name: FreeDVSetupProgram
+        path: ${{github.workspace}}
+
+    - uses: ilammy/msvc-dev-cmd@v1
+
+    - name: Install FreeDV on hard drive
+      shell: pwsh
+      run: |
+          .\FreeDV.exe /S /D=${{github.workspace}}\FreeDV-Install-Location | Out-Null
+
+    - name: Copy test script to install folder
+      shell: pwsh
+      run: |
+          Copy-Item -Path ${{github.workspace}}/test/TestFreeDVFullDuplex.ps1 -Destination ${{github.workspace}}\FreeDV-Install-Location\bin
+          Copy-Item -Path ${{github.workspace}}/test/freedv-ctest-fullduplex.conf.tmpl -Destination ${{github.workspace}}\FreeDV-Install-Location\bin
+
+    - name: Install VB-Cable ("Radio" sound device)
+      uses: LABSN/sound-ci-helpers@v1
+
+    - run: 'Invoke-WebRequest https://software.muzychenko.net/trials/vac464.zip -OutFile vac464.zip'
+    - run: 'Expand-Archive -Path vac464.zip -DestinationPath vac464'
+    - run: 'Import-Certificate -FilePath ${{github.workspace}}\test\vac464.cer -CertStoreLocation Cert:\LocalMachine\root'
+    - run: 'Import-Certificate -FilePath ${{github.workspace}}\test\vac464.cer -CertStoreLocation Cert:\LocalMachine\TrustedPublisher'
+    - name: Install driver
+      shell: pwsh
+      run: |
+          .\vac464\setup64.exe -s -k 30570681-0a8b-46e5-8cb2-d835f43af0c5 | Out-Null
+          Start-Sleep -Seconds 10
+      # For convenience, make sure we fail fast if for whatever reason the install gets blocked on some GUI prompt.
+      timeout-minutes: 5
+
+    - name: Grant FreeDV access to the microphone 
+      run: |
+          Set-ItemProperty -Path "HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\CapabilityAccessManager\ConsentStore\microphone" -Name Value -Value Allow
+          Set-ItemProperty -Path "HKCU:\SOFTWARE\Microsoft\Windows\CurrentVersion\CapabilityAccessManager\ConsentStore\microphone" -Name Value -Value Allow
+          New-Item -Path "HKCU:\SOFTWARE\Microsoft\Windows\CurrentVersion\CapabilityAccessManager\ConsentStore\microphone\" -Name "NonPackaged" -Force
+          Set-ItemProperty -Path "HKCU:\SOFTWARE\Microsoft\Windows\CurrentVersion\CapabilityAccessManager\ConsentStore\microphone\NonPackaged" -Name Value -Value Allow
+          New-Item -Path "HKLM:\SOFTWARE\Policies\Microsoft\Windows\" -Name "AppPrivacy" -Force
+          Set-ItemProperty -Path "HKLM:\SOFTWARE\Policies\Microsoft\Windows\AppPrivacy" -Name LetAppsAccessMicrophone -Value 0
+
+    - name: Start Windows Audio Service
+      run: |
+          net start audiosrv
+
+    - name: List audio devices
+      shell: pwsh
+      run: |
+          Get-CimInstance win32_sounddevice
+
+    - name: Test RADE
+      shell: pwsh
+      working-directory: ${{github.workspace}}\FreeDV-Install-Location\bin
+      run: |
+          .\TestFreeDVFullDuplex.ps1 -RadioToComputerDevice "${{env.RADIO_TO_COMPUTER_DEVICE}}" -ComputerToRadioDevice "${{env.COMPUTER_TO_RADIO_DEVICE}}" -MicrophoneToComputerDevice "${{env.MICROPHONE_TO_COMPUTER_DEVICE}}" -ComputerToSpeakerDevice "${{env.COMPUTER_TO_SPEAKER_DEVICE}}" -ModeToTest RADE -NumberOfRuns 1
+      timeout-minutes: 5
+
+    - name: Test 700D
+      shell: pwsh
+      working-directory: ${{github.workspace}}\FreeDV-Install-Location\bin
+      run: |
+          .\TestFreeDVFullDuplex.ps1 -RadioToComputerDevice "${{env.RADIO_TO_COMPUTER_DEVICE}}" -ComputerToRadioDevice "${{env.COMPUTER_TO_RADIO_DEVICE}}" -MicrophoneToComputerDevice "${{env.MICROPHONE_TO_COMPUTER_DEVICE}}" -ComputerToSpeakerDevice "${{env.COMPUTER_TO_SPEAKER_DEVICE}}" -ModeToTest 700D -NumberOfRuns 1
+      timeout-minutes: 5
+
+    - name: Test 700E
+      shell: pwsh
+      working-directory: ${{github.workspace}}\FreeDV-Install-Location\bin
+      run: |
+          .\TestFreeDVFullDuplex.ps1 -RadioToComputerDevice "${{env.RADIO_TO_COMPUTER_DEVICE}}" -ComputerToRadioDevice "${{env.COMPUTER_TO_RADIO_DEVICE}}" -MicrophoneToComputerDevice "${{env.MICROPHONE_TO_COMPUTER_DEVICE}}" -ComputerToSpeakerDevice "${{env.COMPUTER_TO_SPEAKER_DEVICE}}" -ModeToTest 700E -NumberOfRuns 1
+      timeout-minutes: 5
+
+    - name: Test 1600
+      shell: pwsh
+      working-directory: ${{github.workspace}}\FreeDV-Install-Location\bin
+      run: |
+          .\TestFreeDVFullDuplex.ps1 -RadioToComputerDevice "${{env.RADIO_TO_COMPUTER_DEVICE}}" -ComputerToRadioDevice "${{env.COMPUTER_TO_RADIO_DEVICE}}" -MicrophoneToComputerDevice "${{env.MICROPHONE_TO_COMPUTER_DEVICE}}" -ComputerToSpeakerDevice "${{env.COMPUTER_TO_SPEAKER_DEVICE}}" -ModeToTest 1600 -NumberOfRuns 1
+      timeout-minutes: 5
+

CMakeLists.txt

@@ -719,3 +719,17 @@ elseif(UNIX AND NOT APPLE)
     include(CPack)
 
 endif(WIN32)
+
+if(UNITTEST)
+# The below tests are currently Linux-only due to a dependency on
+# PulseAudio/pipewire.
+macro(DefineAudioTest utName)
+    add_test(NAME fullduplex_${utName} COMMAND ${CMAKE_CURRENT_SOURCE_DIR}/test/test_zeros.sh txrx ${utName}) 
+    set_tests_properties(fullduplex_${utName} PROPERTIES PASS_REGULAR_EXPRESSION "Got 1 sync changes")
+endmacro()
+
+DefineAudioTest(RADE)
+DefineAudioTest(700D)
+DefineAudioTest(700E)
+DefineAudioTest(1600)
+endif(UNITTEST)

build_macos_sound_drivers.sh

@@ -0,0 +1,51 @@
+#!/bin/bash
+
+git clone https://github.com/tmiw/BlackHole.git
+cd BlackHole
+
+bundleID=audio.existential.BlackHoleRadio
+driverName=BlackHoleRadio
+
+xcodebuild \
+    -project BlackHole.xcodeproj \
+    -configuration Release \
+    -target BlackHole \
+    CONFIGURATION_BUILD_DIR=build \
+    PRODUCT_BUNDLE_IDENTIFIER=$bundleID \
+    GCC_PREPROCESSOR_DEFINITIONS="$GCC_PREPROCESSOR_DEFINITIONS \
+        kNumber_Of_Channels='2' \
+        kPlugIn_BundleID='\"$bundleID\"' \
+        kDriver_Name='\"$driverName\"' \
+        kDevice2_IsHidden=false \
+        kDevice2_HasInput=true \
+        kDevice2_HasOutput=true" \
+    MACOSX_DEPLOYMENT_TARGET=10.13
+
+sudo mv build/BlackHole.driver /Library/Audio/Plug-Ins/HAL/$driverName.driver
+
+for i in {1..2}; do
+    git reset --hard
+    rm -rf build
+
+    export bundleID=audio.existential.BlackHole$i
+    export driverName=BlackHole$i
+
+    xcodebuild \
+        -project BlackHole.xcodeproj \
+        -configuration Release \
+        -target BlackHole \
+        CONFIGURATION_BUILD_DIR=build \
+        PRODUCT_BUNDLE_IDENTIFIER=$bundleID \
+        GCC_PREPROCESSOR_DEFINITIONS="$GCC_PREPROCESSOR_DEFINITIONS \
+            kNumber_Of_Channels='2' \
+            kPlugIn_BundleID='\"$bundleID\"' \
+            kDriver_Name='\"$driverName\"' \
+            kDevice2_IsHidden=false \
+            kDevice2_HasInput=true \
+            kDevice2_HasOutput=true" \
+        MACOSX_DEPLOYMENT_TARGET=10.13
+
+    sudo mv build/BlackHole.driver /Library/Audio/Plug-Ins/HAL/$driverName.driver
+done
+
+sudo killall -9 coreaudiod

cmake/BuildRADE.cmake

@@ -13,7 +13,7 @@ ExternalProject_Add(build_rade
    SOURCE_DIR rade_src
    BINARY_DIR rade_build
    GIT_REPOSITORY https://github.com/drowe67/radae.git
-   GIT_TAG dr-reset
+   GIT_TAG main
    CMAKE_ARGS ${RADE_CMAKE_ARGS}
    #CMAKE_CACHE_ARGS -DCMAKE_OSX_DEPLOYMENT_TARGET:STRING=${CMAKE_OSX_DEPLOYMENT_TARGET}
    INSTALL_COMMAND ""

cmake/Buildportaudio-2.0.cmake

@@ -1,4 +1,5 @@
 #set(BUILD_SHARED_LIBS OFF CACHE STRING "Disable shared libraries for portaudio")
+#set(PA_ENABLE_DEBUG_OUTPUT ON CACHE STRING "Enable debug output")
 
 include(FetchContent)
 FetchContent_Declare(

src/audio/PulseAudioDevice.cpp

@@ -145,6 +145,7 @@ void PulseAudioDevice::start()
         outputPendingLength_ = 0;
         targetOutputPendingLength_ = PULSE_FPB * getNumChannels() * 2;
         outputPendingThreadActive_ = true;
+#if 0
         if (direction_ == IAudioEngine::AUDIO_ENGINE_OUT)
         {
             outputPendingThread_ = new std::thread([&]() {
@@ -200,6 +201,7 @@ void PulseAudioDevice::start()
             });
             assert(outputPendingThread_ != nullptr);
         }
+#endif
     }
 
     pa_threaded_mainloop_unlock(mainloop_);
@@ -268,6 +270,7 @@ void PulseAudioDevice::StreamWriteCallback_(pa_stream *s, size_t length, void *u
         memset(data, 0, sizeof(data));
 
         PulseAudioDevice* thisObj = static_cast<PulseAudioDevice*>(userdata);
+#if 0
         {
             std::unique_lock<std::mutex> lk(thisObj->outputPendingMutex_);
             if (thisObj->outputPendingLength_ >= numSamples)
@@ -286,7 +289,12 @@ void PulseAudioDevice::StreamWriteCallback_(pa_stream *s, size_t length, void *u
 
             thisObj->targetOutputPendingLength_ = std::max(thisObj->targetOutputPendingLength_, 2 * numSamples);
         }
+#endif
 
+        if (thisObj->onAudioDataFunction)
+        {
+            thisObj->onAudioDataFunction(*thisObj, data, numSamples / thisObj->getNumChannels(), thisObj->onAudioDataState);
+        } 
         pa_stream_write(s, &data[0], length, NULL, 0LL, PA_SEEK_RELATIVE);
     }
 }