Deprecate PortAudio support on Linux.

CMakeLists.txt

@@ -134,7 +134,7 @@ set(USE_STATIC_SPEEXDSP FALSE CACHE BOOL
     "Download and build static speex instead of the system library.")
 set(BOOTSTRAP_WXWIDGETS FALSE CACHE BOOL
     "Download and build static wxWidgets instead of the system library.")
-set(USE_PULSEAUDIO FALSE CACHE BOOL
+set(USE_PULSEAUDIO TRUE CACHE BOOL
     "Use PulseAudio instead of PortAudio for audio I/O.")
 
 if(USE_STATIC_DEPS)
@@ -326,6 +326,9 @@ else(CODEC2_BUILD_DIR)
     endif()
 endif(CODEC2_BUILD_DIR)
 
+if (NOT USE_PULSEAUDIO AND LINUX)
+    message(WARNING "Use of PortAudio on Linux has been deprecated and may be explicitly disallowed in a future release. It is highly recommended that you use FreeDV's built-in PulseAudio support instead as this generally gives better results, especially on distributions that now use pipewire for audio.")
+endif(NOT USE_PULSEAUDIO AND LINUX)
 
 #
 # Find or build portaudio/PulseAudio Library
@@ -353,7 +356,7 @@ On Windows it's easiest to use the cmake option: USE_STATIC_PORTAUDIO"
     if(NOT ${PORTAUDIO_VERSION} EQUAL 19 AND NOT MINGW)
         message(WARNING "Portaudio versions other than 19 are known to have issues. You have been warned!")
     endif()
-elseif(USE_PULSEAUDIO)
+elseif(USE_PULSEAUDIO AND LINUX)
     message(STATUS "Finding PulseAudio...")
     find_package(PulseAudio REQUIRED)
     if(PULSEAUDIO_FOUND)

USER_MANUAL.md

@@ -905,6 +905,7 @@ LDPC | Low Density Parity Check Codes - a family of powerful FEC codes
     * Adjust sizing of main page tabs for better readability. (PR #487)
 3. Build system:
     * Update Codec2 to v1.2.0. (PR #483)
+    * Deprecate PortAudio support on Linux. (PR #489)
 4. Cleanup:
     * Remove 2400B mode from the UI. (PR #479)
 

build_linux.sh

@@ -10,7 +10,7 @@ set -x -e
 UT_ENABLE=${UT_ENABLE:-0}
 
 # Allow building of either PulseAudio or PortAudio variants
-FREEDV_VARIANT=${1:-portaudio}
+FREEDV_VARIANT=${1:-pulseaudio}
 if [[ "$FREEDV_VARIANT" != "portaudio" && "$FREEDV_VARIANT" != "pulseaudio" ]]; then
     echo "Usage: build_linux.sh [portaudio|pulseaudio]"
     exit -1
@@ -56,6 +56,8 @@ fi
 mkdir  -p build_linux && cd build_linux && rm -Rf *
 if [[ "$FREEDV_VARIANT" == "pulseaudio" ]]; then
     PULSEAUDIO_PARAM="-DUSE_PULSEAUDIO=1"
+else
+    PULSEAUDIO_PARAM="-DUSE_PULSEAUDIO=0"
 fi
 cmake $PULSEAUDIO_PARAM -DUNITTEST=$UT_ENABLE -DCMAKE_BUILD_TYPE=Debug -DCODEC2_BUILD_DIR=$CODEC2DIR/build_linux -DLPCNET_BUILD_DIR=$LPCNETDIR/build_linux ..
 make VERBOSE=1

src/audio/CMakeLists.txt

@@ -1,16 +1,16 @@
-if(USE_PULSEAUDIO)
+if(USE_PULSEAUDIO AND LINUX)
 set(AUDIO_ENGINE_LIBRARY_SPECIFIC_FILES
     PulseAudioDevice.cpp
     PulseAudioEngine.cpp
     )
 
-else(USE_PULSEAUDIO)
+else(USE_PULSEAUDIO AND LINUX)
 set(AUDIO_ENGINE_LIBRARY_SPECIFIC_FILES
     PortAudioDevice.cpp
     PortAudioEngine.cpp
     )
 
-endif(USE_PULSEAUDIO)
+endif(USE_PULSEAUDIO AND LINUX)
 
 add_library(fdv_audio STATIC
     AudioDeviceSpecification.cpp
@@ -24,4 +24,4 @@ if(BOOTSTRAP_WXWIDGETS)
     add_dependencies(fdv_audio wx::core wx::base wx::aui wx::html wx::net wx::adv wx::propgrid wx::xrc)
     target_compile_definitions(fdv_audio PRIVATE ${WXBUILD_BUILD_DEFS})
     target_include_directories(fdv_audio PRIVATE ${WXBUILD_INCLUDES})
-endif(BOOTSTRAP_WXWIDGETS)
+endif(BOOTSTRAP_WXWIDGETS)