drowe67 · tmiw · Feb 5, 2022 · Dec 19, 2021 · Dec 19, 2021 · Dec 19, 2021
diff --git a/.github/workflows/cmake.yml b/.github/workflows/cmake.yml
@@ -24,9 +24,14 @@ jobs:
       shell: bash
       run: |
            sudo apt-get update
-           sudo apt-get install libspeexdsp-dev libsamplerate0-dev sox git libwxgtk3.0-gtk3-dev portaudio19-dev libhamlib-dev libasound2-dev libao-dev libgsm1-dev libsndfile-dev
+           sudo apt-get install libpulse-dev libspeexdsp-dev libsamplerate0-dev sox git libwxgtk3.0-gtk3-dev portaudio19-dev libhamlib-dev libasound2-dev libao-dev libgsm1-dev libsndfile-dev
 
-    - name: Build freedv-gui
+    - name: Build freedv-gui using PortAudio
       shell: bash
       working-directory: ${{github.workspace}}
-      run: ./build_linux.sh
+      run: ./build_linux.sh portaudio
+
+    - name: Build freedv-gui using PulseAudio
+      shell: bash
+      working-directory: ${{github.workspace}}
+      run: ./build_linux.sh pulseaudio
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -49,8 +49,8 @@ message(STATUS "Compilation date = XX${DATE_RESULT}XX")
 #
 set(FREEDV_VERSION_MAJOR 1)
 set(FREEDV_VERSION_MINOR 6)
-set(FREEDV_VERSION_PATCH 1)
-set(FREEDV_VERSION_SUFFIX "")
+set(FREEDV_VERSION_PATCH 2)
+set(FREEDV_VERSION_SUFFIX "pulseaudio-devel")
 
 set(FREEDV_VERSION ${FREEDV_VERSION_MAJOR}.${FREEDV_VERSION_MINOR})
 if(FREEDV_VERSION_PATCH)
@@ -122,6 +122,8 @@ 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
+    "Use PulseAudio instead of PortAudio for audio I/O.")
 
 if(USE_STATIC_DEPS)
     set(USE_STATIC_PORTAUDIO TRUE FORCE)
@@ -284,9 +286,9 @@ endif(CODEC2_BUILD_DIR)
 
 
 #
-# Find or build portaudio Library
+# Find or build portaudio/PulseAudio Library
 #
-if(NOT USE_STATIC_PORTAUDIO)
+if(NOT USE_STATIC_PORTAUDIO AND NOT USE_PULSEAUDIO)
     message(STATUS "Looking for portaudio...")
     find_package(portaudio-2.0 REQUIRED)
     if(PORTAUDIO_FOUND)
@@ -309,10 +311,26 @@ 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()
-else(NOT USE_STATIC_PORTAUDIO)
+elseif(USE_PULSEAUDIO)
+    message(STATUS "Finding PulseAudio...")
+    find_package(PulseAudio REQUIRED)
+    if(PULSEAUDIO_FOUND)
+        message(STATUS "  PulseAudio library: ${PULSEAUDIO_LIBRARY}")
+        message(STATUS "  PulseAudio headers: ${PULSEAUDIO_INCLUDE_DIR}")
+        list(APPEND FREEDV_LINK_LIBS ${PULSEAUDIO_LIBRARY})
+        include_directories(${PULSEAUDIO_INCLUDE_DIR})
+        add_definitions(-DAUDIO_ENGINE_PULSEAUDIO_ENABLE)
+    else()
+        message(FATAL_ERROR "PulseAudio library not found.
+On Linux systems try installing:
+    pulseaudio-libs-devel  (RPM based systems)
+    libpulse-dev           (DEB based systems)
+")
+     endif()
+else()
     message(STATUS "Will attempt static build of portaudio.")
     include(cmake/Buildportaudio-2.0.cmake)
-endif(NOT USE_STATIC_PORTAUDIO)
+endif()
 
 #
 # Hamlib library
@@ -563,7 +581,12 @@ elseif(UNIX AND NOT APPLE)
     # Linux packaging
     SET(CPACK_GENERATOR "DEB")
     SET(CPACK_DEBIAN_PACKAGE_MAINTAINER "Mooneer Salem <mooneer@gmail.com>") #required
-    SET(CPACK_DEBIAN_PACKAGE_DEPENDS "codec2 (>= 0.9.2), libspeexdsp1 (>= 1.2~rc1.2-1+b2), libsamplerate0 (>= 0.1.9-2), libwxgtk3.0-gtk3-0v5  (>= 3.0.4+dfsg-3), libportaudio2 (>= 19.6.0-1build1), libhamlib2 (>= 3.3-10build1), libasound2 (>= 1.1.8-1), libao4 (>= 1.2.2+20180113-1), libgsm1 (>= 1.0.18-2), libsndfile1 (>= 1.0.28-6)")
+    if(USE_PULSEAUDIO)
+    SET(CPACK_DEBIAN_PACKAGE_DEPENDS "codec2 (>= 1.0.0), libspeexdsp1 (>= 1.2~rc1.2-1+b2), libsamplerate0 (>= 0.1.9-2), libwxgtk3.0-gtk3-0v5  (>= 3.0.4+dfsg-3), libpulse0 (>= 14.2-2), libhamlib2 (>= 3.3-10build1), libasound2 (>= 1.1.8-1), libao4 (>= 1.2.2+20180113-1), libgsm1 (>= 1.0.18-2), libsndfile1 (>= 1.0.28-6)")
+    else(USE_PULSEAUDIO)
+    SET(CPACK_DEBIAN_PACKAGE_DEPENDS "codec2 (>= 1.0.0), libspeexdsp1 (>= 1.2~rc1.2-1+b2), libsamplerate0 (>= 0.1.9-2), libwxgtk3.0-gtk3-0v5  (>= 3.0.4+dfsg-3), libportaudio2 (>= 19.6.0-1build1), libhamlib2 (>= 3.3-10build1), libasound2 (>= 1.1.8-1), libao4 (>= 1.2.2+20180113-1), libgsm1 (>= 1.0.18-2), libsndfile1 (>= 1.0.28-6)")
+    endif(USE_PULSEAUDIO)
+
     SET(CPACK_DEBIAN_FILE_NAME DEB-DEFAULT)
     include(CPack)
 

diff --git a/README.md b/README.md
@@ -8,14 +8,14 @@ This document describes how to build the FreeDV GUI program for various operatin
   * [FreeDV GUI User Manual](USER_MANUAL.md)
   * [Building for Windows using Docker](docker/README_docker.md)
 
-## Building on Ubuntu Linux (16-20)
+## Building on Ubuntu Linux (16-20) with PortAudio
   ```
   $ sudo apt install libspeexdsp-dev libsamplerate0-dev sox git \
   libwxgtk3.0-gtk3-dev portaudio19-dev libhamlib-dev libasound2-dev libao-dev \
   libgsm1-dev libsndfile-dev cmake module-assistant build-essential
   $ git clone https://github.com/drowe67/freedv-gui.git
   $ cd freedv-gui
-  $ ./build_linux.sh
+  $ ./build_linux.sh portaudio
   ```
   (For Ubuntu 20.04 the wxWidgets package is named `libwxgtk3.0-gtk3-dev`.)
 
@@ -26,21 +26,54 @@ This document describes how to build the FreeDV GUI program for various operatin
 
   Note this builds all libraries locally, nothing is installed on your machine.  ```make install``` is not required.
 
-## Building on Fedora Linux
+## Building on Fedora Linux with PortAudio
   ```
   $ sudo dnf groupinstall "Development Tools"
   $ sudo dnf install cmake wxGTK3-devel portaudio-devel libsamplerate-devel \
     libsndfile-devel speexdsp-devel hamlib-devel alsa-lib-devel libao-devel \
     gsm-devel
   $ git clone https://github.com/drowe67/freedv-gui.git
   $ cd freedv-gui
-  $ ./build_linux.sh
+  $ ./build_linux.sh portaudio
   ```
   Then run with:
   ```
   $ ./build_linux/src/freedv
   ```
 
+## Building on Ubuntu Linux (16-20) with PulseAudio
+  ```
+  $ sudo apt install libspeexdsp-dev libsamplerate0-dev sox git \
+  libwxgtk3.0-gtk3-dev libhamlib-dev libasound2-dev libao-dev \
+  libgsm1-dev libsndfile-dev cmake module-assistant build-essential libpulse-dev
+  $ git clone https://github.com/drowe67/freedv-gui.git
+  $ cd freedv-gui
+  $ ./build_linux.sh pulseaudio
+  ```
+  (For Ubuntu 20.04 the wxWidgets package is named `libwxgtk3.0-gtk3-dev`.)
+
+  Then run with:
+  ```
+  $ ./build_linux/src/freedv
+  ```
+
+  Note this builds all libraries locally, nothing is installed on your machine.  ```make install``` is not required.
+
+## Building on Fedora Linux with PulseAudio
+  ```
+  $ sudo dnf groupinstall "Development Tools"
+  $ sudo dnf install cmake wxGTK3-devel libsamplerate-devel \
+    libsndfile-devel speexdsp-devel hamlib-devel alsa-lib-devel libao-devel \
+    gsm-devel pulseaudio-libs-devel
+  $ git clone https://github.com/drowe67/freedv-gui.git
+  $ cd freedv-gui
+  $ ./build_linux.sh pulseaudio
+  ```
+  Then run with:
+  ```
+  $ ./build_linux/src/freedv
+  ```
+
 ## Installing on Linux
 
 You need to install the codec2 and lpcnetfreedv shared libraries, and freedv-gui:
@@ -130,7 +163,7 @@ Testing FreeDV API:
   $ play -t .s16 -r 16000 -b 16 out.raw
 ```
 
-## Building and installing on OSX
+## Building and installing on macOS
 
 Please see [README.osx](README.osx).
 

diff --git a/USER_MANUAL.pdf b/USER_MANUAL.pdf
diff --git a/build_linux.sh b/build_linux.sh
@@ -1,12 +1,19 @@
 #!/usr/bin/env bash
-# build_ubuntu.sh
+# build_linux.sh
 #
 # Build script for Ubuntu and Fedora Linux, git pulls codec2 and
 # lpcnet repos so they are available for parallel development.
 
 # Echo what you are doing, and fail if any of the steps fail:
 set -x -e
 
+# Allow building of either PulseAudio or PortAudio variants
+FREEDV_VARIANT=${1:-portaudio}
+if [[ "$FREEDV_VARIANT" != "portaudio" && "$FREEDV_VARIANT" != "pulseaudio" ]]; then
+    echo "Usage: build_linux.sh [portaudio|pulseaudio]"
+    exit -1
+fi
+
 export FREEDVGUIDIR=${PWD}
 export CODEC2DIR=$FREEDVGUIDIR/codec2
 export LPCNETDIR=$FREEDVGUIDIR/LPCNet
@@ -46,5 +53,8 @@ export LD_LIBRARY_PATH=$LPCNETDIR/build_linux/src
 # Finally, build freedv-gui
 cd $FREEDVGUIDIR && git pull
 mkdir  -p build_linux && cd build_linux && rm -Rf *
-cmake -DCMAKE_BUILD_TYPE=Debug -DCODEC2_BUILD_DIR=$CODEC2DIR/build_linux -DLPCNET_BUILD_DIR=$LPCNETDIR/build_linux ..
+if [[ "$FREEDV_VARIANT" == "pulseaudio" ]]; then
+    PULSEAUDIO_PARAM="-DUSE_PULSEAUDIO=1"
+fi
+cmake $PULSEAUDIO_PARAM -DCMAKE_BUILD_TYPE=Debug -DCODEC2_BUILD_DIR=$CODEC2DIR/build_linux -DLPCNET_BUILD_DIR=$LPCNETDIR/build_linux ..
 make VERBOSE=1
diff --git a/build_osx.sh b/build_osx.sh
@@ -32,7 +32,7 @@ cd $FREEDVGUIDIR
 if [ ! -d codec2 ]; then
     git clone https://github.com/drowe67/codec2.git
 fi
-cd codec2 && git checkout ms-reliable-text && git pull
+cd codec2 && git checkout master && git pull
 mkdir -p build_osx && cd build_osx && rm -Rf * && cmake -DBUILD_OSX_UNIVERSAL=1 .. && make -j4
 
 # OK, build and test LPCNet

diff --git a/docker/fdv_win_fedora/Dockerfile b/docker/fdv_win_fedora/Dockerfile
@@ -8,7 +8,7 @@ FROM fedora:${FED_REL}
 # tar: bzip2
 # arm-none-eabi-gdb: ncurses-compat-libs
 
-RUN dnf -y install --setopt=install_weak_deps=False @development-tools cmake git speexdsp-devel libsamplerate-devel octave octave-signal gnuplot sox python3-numpy automake libtool libusb1-devel wget bc glibc.i686 which bzip2 ncurses-compat-libs && useradd -m build 
+RUN dnf -y install --setopt=install_weak_deps=False @development-tools cmake git speexdsp-devel libsamplerate-devel octave octave-signal gnuplot sox python3-numpy automake libtool libusb1-devel wget bc glibc.i686 which bzip2 ncurses-compat-libs gcc gcc-c++ && useradd -m build 
 
 # specific for windows mingw build
 RUN dnf install -y dnf-plugins-core

diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
@@ -4,7 +4,6 @@ set(FREEDV_SOURCES
     dlg_options.cpp
     dlg_ptt.cpp
     main.cpp
-    pa_wrapper.cpp
     plot.cpp
     plot_scalar.cpp
     plot_scatter.cpp
@@ -21,7 +20,6 @@ set(FREEDV_SOURCES
     dlg_ptt.h
     defines.h
     main.h
-    pa_wrapper.h
     plot.h
     plot_scalar.h
     plot_scatter.h
@@ -67,6 +65,9 @@ set(FREEDV_LINK_LIBS_OSX
     "-framework AVFoundation"
 )
 
+# Compile FreeDV components
+add_subdirectory(audio)
+
 # WIN32 is needed for Windows GUI apps and is ignored for UNIX like systems.
 # In addition, there are some required OSX-specific code files for platform specific handling.
 if(APPLE)
@@ -90,9 +91,9 @@ endif(APPLE)
 
 # Link imported or build tree targets.
 if(APPLE)
-target_link_libraries(FreeDV codec2 lpcnetfreedv)
+target_link_libraries(FreeDV codec2 lpcnetfreedv fdv_audio)
 else(APPLE)
-target_link_libraries(freedv codec2 lpcnetfreedv)
+target_link_libraries(freedv codec2 lpcnetfreedv fdv_audio)
 endif(APPLE)
 
 # Add build dependencies for interally built external libraries.

diff --git a/src/audio/AudioDeviceSpecification.cpp b/src/audio/AudioDeviceSpecification.cpp
@@ -0,0 +1,37 @@
+//=========================================================================
+// Name:            AudioDeviceSpecification.cpp
+// Purpose:         Describes an audio device on the user's system.
+//
+// Authors:         Mooneer Salem
+// License:
+//
+//  All rights reserved.
+//
+//  This program is free software; you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License version 2.1,
+//  as published by the Free Software Foundation.  This program is
+//  distributed in the hope that it will be useful, but WITHOUT ANY
+//  WARRANTY; without even the implied warranty of MERCHANTABILITY or
+//  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
+//  License for more details.
+//
+//  You should have received a copy of the GNU General Public License
+//  along with this program; if not, see <http://www.gnu.org/licenses/>.
+//
+//=========================================================================
+
+#include "AudioDeviceSpecification.h"
+
+bool AudioDeviceSpecification::isValid() const
+{
+    return deviceId != -1;
+}
+
+AudioDeviceSpecification AudioDeviceSpecification::GetInvalidDevice()
+{
+    AudioDeviceSpecification result = {
+        .deviceId = -1
+    };
+
+    return result;
+}
diff --git a/src/audio/AudioDeviceSpecification.h b/src/audio/AudioDeviceSpecification.h
@@ -0,0 +1,41 @@
+//=========================================================================
+// Name:            AudioDeviceSpecification.h
+// Purpose:         Describes an audio device on the user's system.
+//
+// Authors:         Mooneer Salem
+// License:
+//
+//  All rights reserved.
+//
+//  This program is free software; you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License version 2.1,
+//  as published by the Free Software Foundation.  This program is
+//  distributed in the hope that it will be useful, but WITHOUT ANY
+//  WARRANTY; without even the implied warranty of MERCHANTABILITY or
+//  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
+//  License for more details.
+//
+//  You should have received a copy of the GNU General Public License
+//  along with this program; if not, see <http://www.gnu.org/licenses/>.
+//
+//=========================================================================
+
+#ifndef AUDIO_DEVICE_SPECIFICATION_H
+#define AUDIO_DEVICE_SPECIFICATION_H
+
+#include <wx/string.h>
+#include <vector>
+
+struct AudioDeviceSpecification
+{
+    int deviceId;
+    wxString name;
+    wxString apiName;
+    int defaultSampleRate;
+    int maxChannels;
+
+    bool isValid() const;
+    static AudioDeviceSpecification GetInvalidDevice();
+};
+
+#endif // AUDIO_DEVICE_SPECIFICATION_H
diff --git a/src/audio/AudioEngineFactory.cpp b/src/audio/AudioEngineFactory.cpp
@@ -0,0 +1,44 @@
+//=========================================================================
+// Name:            AudioEngineFactory.cpp
+// Purpose:         Creates AudioEngines for the current platform.
+//
+// Authors:         Mooneer Salem
+// License:
+//
+//  All rights reserved.
+//
+//  This program is free software; you can redistribute it and/or modify
+//  it under the terms of the GNU General Public License version 2.1,
+//  as published by the Free Software Foundation.  This program is
+//  distributed in the hope that it will be useful, but WITHOUT ANY
+//  WARRANTY; without even the implied warranty of MERCHANTABILITY or
+//  FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
+//  License for more details.
+//
+//  You should have received a copy of the GNU General Public License
+//  along with this program; if not, see <http://www.gnu.org/licenses/>.
+//
+//=========================================================================
+
+#include "AudioEngineFactory.h"
+#if defined(AUDIO_ENGINE_PULSEAUDIO_ENABLE)
+#include "PulseAudioEngine.h"
+#else
+#include "PortAudioEngine.h"
+#endif // defined(AUDIO_ENGINE_PULSEAUDIO_ENABLE)
+
+std::shared_ptr<IAudioEngine> AudioEngineFactory::SystemEngine_;
+
+std::shared_ptr<IAudioEngine> AudioEngineFactory::GetAudioEngine()
+{
+    if (!SystemEngine_)
+    {
+#if defined(AUDIO_ENGINE_PULSEAUDIO_ENABLE)
+        SystemEngine_ = std::shared_ptr<IAudioEngine>(new PulseAudioEngine());
+#else
+        SystemEngine_ = std::shared_ptr<IAudioEngine>(new PortAudioEngine());
+#endif // defined(AUDIO_ENGINE_PULSEAUDIO_ENABLE)
+    }
+
+    return SystemEngine_;
+}