[WIP] Initial support for piping audio through external vocoder programs.

radae_demo_rx.sh

@@ -0,0 +1,15 @@
+#!/bin/sh
+
+RADAE_PATH=$1
+RADAE_VENV=$2
+
+# Current RADAE scripts seem to require being executed from
+# the RADAE folder.
+cd $RADAE_PATH
+
+# The below does the following:
+# * For each block of OTA audio from freedv-gui:
+# * Convert the audio into IQ data via zero-padding.
+# * Pass the IQ data into the RADAE decoder 
+# * Send the resulting 16 kHz audio back to freedv-gui.
+$RADAE_VENV/bin/python3 $RADAE_PATH/int16tof32.py --zeropad | $RADAE_VENV/bin/python3 $RADAE_PATH/radae_rx.py $RADAE_PATH/model19_check3/checkpoints/checkpoint_epoch_100.pth -v 2 --auxdata | $RADAE_PATH/build/src/lpcnet_demo -fargan-synthesis - -

radae_demo_tx.sh

@@ -0,0 +1,16 @@
+#!/bin/sh
+
+RADAE_PATH=$1
+RADAE_VENV=$2
+
+# Current RADAE scripts seem to require being executed from
+# the RADAE folder.
+cd $RADAE_PATH
+
+# The below does the following:
+# * For each block of OTA audio from freedv-gui:
+# * Convert the audio into IQ data via zero-padding.
+# * Pass the IQ data into the RADAE encoder
+# * Send the resulting 8 kHz audio back to freedv-gui.
+export PATH=$RADAE_VENV/bin:$PATH
+$RADAE_PATH/build/src/lpcnet_demo -features - - | $RADAE_VENV/bin/python3 $RADAE_PATH/radae_tx.py $RADAE_PATH/model19_check3/checkpoints/checkpoint_epoch_100.pth --auxdata | python3 $RADAE_PATH/f32toint16.py --real --scale 16383

src/config/FreeDVConfiguration.cpp

@@ -113,6 +113,9 @@ FreeDVConfiguration::FreeDVConfiguration()
 
  , txRxDelayMilliseconds("/Audio/TxRxDelayMilliseconds", 0)
 
+ , externalVocoderRxCommand("/ExternalVocoder/RxCommand", _(""))
+ , externalVocoderTxCommand("/ExternalVocoder/TxCommand", _(""))
+
  , reportingUserMsgColWidth("/Windows/FreeDVReporter/reportingUserMsgColWidth", 130)
 {
  // empty
@@ -233,6 +236,9 @@ void FreeDVConfiguration::load(wxConfigBase* config)
 
  load_(config, txRxDelayMilliseconds);
 
+ load_(config, externalVocoderRxCommand);
+ load_(config, externalVocoderTxCommand);
+
  load_(config, reportingUserMsgColWidth);
 }
 
@@ -321,6 +327,9 @@ void FreeDVConfiguration::save(wxConfigBase* config)
 
  save_(config, txRxDelayMilliseconds);
 
+ save_(config, externalVocoderRxCommand);
+ save_(config, externalVocoderTxCommand);
+
  save_(config, reportingUserMsgColWidth);
 
  config->Flush();

src/config/FreeDVConfiguration.h

@@ -126,6 +126,9 @@ class FreeDVConfiguration : public WxWidgetsConfigStore
 
  ConfigurationDataElement<int> reportingUserMsgColWidth;
 
+ ConfigurationDataElement<wxString> externalVocoderRxCommand;
+ ConfigurationDataElement<wxString> externalVocoderTxCommand;
+
  virtual void load(wxConfigBase* config) override;
  virtual void save(wxConfigBase* config) override;
 };

src/freedv_interface.cpp

@@ -25,6 +25,7 @@
 #include "pipeline/ParallelStep.h"
 #include "pipeline/FreeDVTransmitStep.h"
 #include "pipeline/FreeDVReceiveStep.h"
+#include "pipeline/ExternVocoderStep.h"
 
 using namespace std::placeholders;
 
@@ -127,6 +128,16 @@ void FreeDVInterface::start(int txMode, int fifoSizeMs, bool singleRxThread, boo
  float minimumSnr = 999.0f;
  for (auto& mode : enabledModes_)
  {
+ if (mode == -1)
+ {
+ // Special-case to allow use of external vocoder
+ // NOTE: multi-RX is NOT supported.
+ rxMode_ = -1;
+ txMode_ = -1;
+ modemStatsIndex_ = 0;
+ continue;
+ }
+
  struct freedv* dv = freedv_open(mode);
  assert(dv != nullptr);
 
@@ -274,16 +285,20 @@ void FreeDVInterface::setTestFrames(bool testFrames, bool combine)
 
 int FreeDVInterface::getTotalBits()
 {
+ if (currentRxMode_ == nullptr) return 1;
  return freedv_get_total_bits(currentRxMode_);
 }
 
 int FreeDVInterface::getTotalBitErrors()
 {
+ if (currentRxMode_ == nullptr) return 0;
  return freedv_get_total_bit_errors(currentRxMode_);
 }
 
 float FreeDVInterface::getVariance() const
 {
+ if (currentRxMode_ == nullptr) return 0.0;
+
  struct CODEC2 *c2 = freedv_get_codec2(currentRxMode_);
  if (c2 != NULL)
  return codec2_get_var(c2);
@@ -293,6 +308,8 @@ float FreeDVInterface::getVariance() const
 
 int FreeDVInterface::getErrorPattern(short** outputPattern)
 {
+ if (currentRxMode_ == nullptr) return 0;
+
  int size = freedv_get_sz_error_pattern(currentRxMode_);
  if (size > 0)
  {
@@ -371,6 +388,7 @@ void FreeDVInterface::setSync(int val)
 
 int FreeDVInterface::getSync() const
 {
+ if (currentRxMode_ == nullptr) return 1;
  return freedv_get_sync(currentRxMode_);
 }
 
@@ -421,24 +439,32 @@ void FreeDVInterface::setTextCallbackFn(void (*rxFunc)(void *, char), char (*txF
 
 int FreeDVInterface::getTxModemSampleRate() const
 {
+ if (txMode_ == -1) return 8000;
+
  assert(currentTxMode_ != nullptr);
  return freedv_get_modem_sample_rate(currentTxMode_);
 }
 
 int FreeDVInterface::getTxSpeechSampleRate() const
 {
+ if (txMode_ == -1) return 8000;
+
  assert(currentTxMode_ != nullptr);
  return freedv_get_speech_sample_rate(currentTxMode_);
 }
 
 int FreeDVInterface::getTxNumSpeechSamples() const
 {
+ if (txMode_ == -1) return 1024;
+
  assert(currentTxMode_ != nullptr);
  return freedv_get_n_speech_samples(currentTxMode_); 
 }
 
 int FreeDVInterface::getTxNNomModemSamples() const
 {
+ if (txMode_ == -1) return 1024;
+
  assert(currentTxMode_ != nullptr);
  return freedv_get_n_nom_modem_samples(currentTxMode_); 
 }
@@ -465,6 +491,8 @@ void FreeDVInterface::setTextVaricodeNum(int num)
 
 int FreeDVInterface::getRxModemSampleRate() const
 {
+ if (rxMode_ == -1) return 8000;
+
  int result = 0;
  for (auto& dv : dvObjects_)
  {
@@ -476,6 +504,8 @@ int FreeDVInterface::getRxModemSampleRate() const
 
 int FreeDVInterface::getRxNumModemSamples() const
 {
+ if (rxMode_ == -1) return 1024;
+
  int result = 0;
  for (auto& dv : dvObjects_)
  {
@@ -487,6 +517,8 @@ int FreeDVInterface::getRxNumModemSamples() const
 
 int FreeDVInterface::getRxNumSpeechSamples() const
 {
+ if (rxMode_ == -1) return 1024;
+
  int result = 0;
  for (auto& dv : dvObjects_)
  {
@@ -498,6 +530,8 @@ int FreeDVInterface::getRxNumSpeechSamples() const
 
 int FreeDVInterface::getRxSpeechSampleRate() const
 {
+ if (rxMode_ == -1) return 8000;
+
  int result = 0;
  for (auto& dv : dvObjects_)
  {
@@ -559,14 +593,23 @@ void FreeDVInterface::setReliableText(const char* callsign)
 IPipelineStep* FreeDVInterface::createTransmitPipeline(int inputSampleRate, int outputSampleRate, std::function<float()> getFreqOffsetFn)
 {
  std::vector<IPipelineStep*> parallelSteps;
-
+
+ if (txMode_ == -1)
+ {
+ // special handling for external vocoder
+ parallelSteps.push_back(new ExternVocoderStep(externVocoderTxCommand_, 16000, 8000));
+ }
+
  for (auto& dv : dvObjects_)
  {
  parallelSteps.push_back(new FreeDVTransmitStep(dv, getFreqOffsetFn));
  }
 
  std::function<int(ParallelStep*)> modeFn = 
  [&](ParallelStep*) {
+ // Special handling for external vocoder.
+ if (txMode_ == -1) return 0;
+
  int index = 0;
  for (auto& dv : dvObjects_)
  {
@@ -608,16 +651,26 @@ IPipelineStep* FreeDVInterface::createReceivePipeline(
  state->getFreqOffsetFn = getFreqOffsetFn;
  state->getSigPwrAvgFn = getSigPwrAvgFn;
 
- for (auto& dv : dvObjects_)
+ if (txMode_ == -1)
  {
- auto recvStep = new FreeDVReceiveStep(dv);
- assert(recvStep != nullptr);
-
- parallelSteps.push_back(recvStep);
+ // special handling for external vocoder
+ parallelSteps.push_back(new ExternVocoderStep(externVocoderRxCommand_, 8000, 16000));
+
+ state->preProcessFn = [&](ParallelStep*) { return -1; };
+ state->postProcessFn = [&](ParallelStep*) { return 0; };
  }
-
- state->preProcessFn = std::bind(&FreeDVInterface::preProcessRxFn_, this, _1);
- state->postProcessFn = std::bind(&FreeDVInterface::postProcessRxFn_, this, _1);
+ else
+ {
+ for (auto& dv : dvObjects_)
+ {
+ auto recvStep = new FreeDVReceiveStep(dv);
+ assert(recvStep != nullptr);
+
+ parallelSteps.push_back(recvStep);
+ }
+ state->preProcessFn = std::bind(&FreeDVInterface::preProcessRxFn_, this, _1);
+ state->postProcessFn = std::bind(&FreeDVInterface::postProcessRxFn_, this, _1);
+ } 
 
  auto parallelStep = new ParallelStep(
  inputSampleRate,
@@ -671,6 +724,8 @@ int FreeDVInterface::postProcessRxFn_(ParallelStep* stepObj)
  int maxSyncFound = -25;
  struct freedv* dvWithSync = nullptr;
 
+ if (dvObjects_.size() == 0) goto skipSyncCheck;
+
  for (auto& dv : dvObjects_)
  {
  if (dv == currentRxMode_ && freedv_get_sync(currentRxMode_))
@@ -726,21 +781,29 @@ int FreeDVInterface::postProcessRxFn_(ParallelStep* stepObj)
 
 skipSyncCheck: 
  struct MODEM_STATS* stats = getCurrentRxModemStats();
-
- // grab extended stats so we can plot spectrum, scatter diagram etc
- freedv_get_modem_extended_stats(dvWithSync, stats);
 
- // Update sync as it may have gone stale during decode
- *state->getRxStateFn() = stats->sync != 0;
-
- if (*state->getRxStateFn())
+ if (dvWithSync != nullptr)
  {
- rxMode_ = enabledModes_[indexWithSync]; 
- currentRxMode_ = dvWithSync;
- lastSyncRxMode_ = currentRxMode_;
- } 
+ // grab extended stats so we can plot spectrum, scatter diagram etc
+ freedv_get_modem_extended_stats(dvWithSync, stats);
 
- *state->getSigPwrAvgFn() = ((FreeDVReceiveStep*)stepObj->getParallelSteps()[indexWithSync].get())->getSigPwrAvg();
+ // Update sync as it may have gone stale during decode
+ *state->getRxStateFn() = stats->sync != 0;
 
+ if (*state->getRxStateFn())
+ {
+ rxMode_ = enabledModes_[indexWithSync]; 
+ currentRxMode_ = dvWithSync;
+ lastSyncRxMode_ = currentRxMode_;
+ } 
+ *state->getSigPwrAvgFn() = ((FreeDVReceiveStep*)stepObj->getParallelSteps()[indexWithSync].get())->getSigPwrAvg();
+ }
+ else
+ {
+ // assume external mode is in sync
+ *state->getRxStateFn() = 1;
+ *state->getSigPwrAvgFn() = 0;
+ }
+
  return indexWithSync;
 };

src/freedv_interface.h

@@ -115,7 +115,10 @@ class FreeDVInterface
  std::function<float()> getFreqOffsetFn,
  std::function<float*()> getSigPwrAvgFn
  );
-
+
+ void setExternVocoderRxCommand(std::string command) { externVocoderRxCommand_ = command; }
+ void setExternVocoderTxCommand(std::string command) { externVocoderTxCommand_ = command; }
+
 private:
  struct ReceivePipelineState
  {
@@ -168,7 +171,10 @@ class FreeDVInterface
  std::deque<reliable_text_t> reliableText_;
  std::string receivedReliableText_;
  std::mutex reliableTextMutex_;
-
+
+ std::string externVocoderRxCommand_;
+ std::string externVocoderTxCommand_;
+
  int preProcessRxFn_(ParallelStep* ps);
  int postProcessRxFn_(ParallelStep* ps);
 };

src/gui/dialogs/dlg_options.cpp

@@ -426,6 +426,33 @@ OptionsDlg::OptionsDlg(wxWindow* parent, wxWindowID id, const wxString& title, c
 
  sizerModem->Add(sbSizer_duplex,0, wxALL | wxEXPAND, 5);
 
+ //------------------------------
+ // External vocoder
+ //------------------------------
+
+ wxStaticBox *sb_vocoder = new wxStaticBox(m_modemTab, wxID_ANY, _("External Vocoder"));
+ wxStaticBoxSizer* sbSizer_vocoder = new wxStaticBoxSizer(sb_vocoder, wxVERTICAL);
+
+ wxSizer* vocoderRxSizer = new wxBoxSizer(wxHORIZONTAL);
+ wxStaticText *staticTextVocoderRXCmd = new wxStaticText(m_modemTab, wxID_ANY, _("RX command: "), wxDefaultPosition, wxDefaultSize, 0);
+ vocoderRxSizer->Add(staticTextVocoderRXCmd, 0, wxALL | wxALIGN_CENTER_VERTICAL, 5);
+
+ m_txtCtrlExternalVocoderRxCommand = 
+ new wxTextCtrl(m_modemTab, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize(300, -1), 0);
+ vocoderRxSizer->Add(m_txtCtrlExternalVocoderRxCommand, 0, wxALL | wxALIGN_CENTER_VERTICAL, 5);
+ sbSizer_vocoder->Add(vocoderRxSizer, 0, wxALL | wxEXPAND, 5);
+
+ wxSizer* vocoderTxSizer = new wxBoxSizer(wxHORIZONTAL);
+ wxStaticText *staticTextVocoderTXCmd = new wxStaticText(m_modemTab, wxID_ANY, _("TX command: "), wxDefaultPosition, wxDefaultSize, 0);
+ vocoderTxSizer->Add(staticTextVocoderTXCmd, 0, wxALL | wxALIGN_CENTER_VERTICAL, 5);
+
+ m_txtCtrlExternalVocoderTxCommand = 
+ new wxTextCtrl(m_modemTab, wxID_ANY, wxEmptyString, wxDefaultPosition, wxSize(300, -1), 0);
+ vocoderTxSizer->Add(m_txtCtrlExternalVocoderTxCommand, 0, wxALL | wxALIGN_CENTER_VERTICAL, 5);
+ sbSizer_vocoder->Add(vocoderTxSizer, 0, wxALL | wxEXPAND, 5);
+
+ sizerModem->Add(sbSizer_vocoder,0, wxALL | wxEXPAND, 5);
+
  //------------------------------
  // Multiple RX selection
  //------------------------------
@@ -837,6 +864,9 @@ void OptionsDlg::ExchangeData(int inout, bool storePersistent)
 
  m_ckHalfDuplex->SetValue(wxGetApp().appConfiguration.halfDuplexMode);
 
+ m_txtCtrlExternalVocoderTxCommand->SetValue(wxGetApp().appConfiguration.externalVocoderTxCommand);
+ m_txtCtrlExternalVocoderRxCommand->SetValue(wxGetApp().appConfiguration.externalVocoderRxCommand);
+
  m_ckboxMultipleRx->SetValue(wxGetApp().appConfiguration.multipleReceiveEnabled);
  m_ckboxSingleRxThread->SetValue(wxGetApp().appConfiguration.multipleReceiveOnSingleThread);
 
@@ -1036,6 +1066,9 @@ void OptionsDlg::ExchangeData(int inout, bool storePersistent)
  wxGetApp().appConfiguration.freedv700TxBPF = m_ckboxFreeDV700txBPF->GetValue();
  wxGetApp().m_FreeDV700Combine = m_ckboxFreeDV700Combine->GetValue();
 
+ wxGetApp().appConfiguration.externalVocoderTxCommand = m_txtCtrlExternalVocoderTxCommand->GetValue();
+ wxGetApp().appConfiguration.externalVocoderRxCommand = m_txtCtrlExternalVocoderRxCommand->GetValue();
+
 #ifdef __WXMSW__
  wxGetApp().appConfiguration.debugConsoleEnabled = m_ckboxDebugConsole->GetValue();
 #endif