Add Config support for Soft Vocoder (#832)

robotastic · web-flow · commit 44787eb7f4f6 · 2023-07-08T08:13:14.000-04:00
* Add support for soft-vocoder

* Update CONFIGURE.md

* Update software_imbe_decoder.cc
diff --git a/docs/CONFIGURE.md b/docs/CONFIGURE.md
@@ -103,6 +103,7 @@ Here is a map of the different sections of the *config.json* file:
 
 ### Global Configs
 
+
 | Key                          | Required | Default Value                                    | Type                                                         | Description                                                  |
 | ---------------------------- | :------: | ------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ |
 | ver                          |    ✓     |                                                  | number                                                       | The version of formatting for the config file. **This should be set to 2**. Trunk Recorder will not start without this set. |
@@ -131,6 +132,8 @@ Here is a map of the different sections of the *config.json* file:
 | debugRecorderAddress         |          | "127.0.0.1"                                      | string                                                       | The network address of the computer that will be monitoring the Debug Recorders. UDP packets will be sent from Trunk Recorder to this computer. The default is *"127.0.0.1"* which is the address used for monitoring on the same computer as Trunk Recorder. |
 | audioStreaming               |          | false                                            | **true** / **false**                                         | Whether or not to enable the audio streaming callbacks for plugins. |
 | newCallFromUpdate            |          | true                                             | **true** / **false**                                         | Allow for UPDATE trunking messages to start a new Call, in addition to GRANT messages. This may result in more Calls with no transmisions, and use more Recorders. The flipside is that it may catch parts of a Call that would have otherwise been missed. Turn this off if you are running out of Recorders. |
+| softVocoder                  |          | false                                            | **true** / **false**                                         | Use the Software Decode vocoder from OP25 for Phase 1 audio. Give it a try if you are hearing weird tones in your audio. Whether it makes your audio sound better or worse is a matter of preference. |
+
 
 
 #### Source Object
diff --git a/lib/op25_repeater/include/op25_repeater/p25_frame_assembler.h b/lib/op25_repeater/include/op25_repeater/p25_frame_assembler.h
@@ -52,7 +52,7 @@ namespace gr {
        * class. op25_repeater::p25_frame_assembler::make is the public interface for
        * creating new instances.
        */
-      static sptr make(int silence_frames, const char* udp_host, int port, int debug, bool do_imbe, bool do_output, bool do_msgq, gr::msg_queue::sptr queue, bool do_audio_output, bool do_phase2_tdma, bool do_nocrypt);
+      static sptr make(int silence_frames, bool soft_vocoder, const char* udp_host, int port, int debug, bool do_imbe, bool do_output, bool do_msgq, gr::msg_queue::sptr queue, bool do_audio_output, bool do_phase2_tdma, bool do_nocrypt);
       virtual void set_xormask(const char*p) {}
       virtual void set_nac(int nac) {}
       virtual void set_slotid(int slotid) {}
diff --git a/lib/op25_repeater/lib/p25_frame_assembler_impl.cc b/lib/op25_repeater/lib/p25_frame_assembler_impl.cc
@@ -74,8 +74,8 @@ namespace gr {
     }
 
     p25_frame_assembler::sptr
-    p25_frame_assembler::make(int silence_frames, const char *udp_host, int port, int debug, bool do_imbe, bool do_output, bool do_msgq, gr::msg_queue::sptr queue, bool do_audio_output, bool do_phase2_tdma, bool do_nocrypt) {
-      return gnuradio::get_initial_sptr(new p25_frame_assembler_impl(silence_frames, udp_host, port, debug, do_imbe, do_output, do_msgq, queue, do_audio_output, do_phase2_tdma, do_nocrypt));
+    p25_frame_assembler::make(int silence_frames, bool soft_vocoder, const char *udp_host, int port, int debug, bool do_imbe, bool do_output, bool do_msgq, gr::msg_queue::sptr queue, bool do_audio_output, bool do_phase2_tdma, bool do_nocrypt) {
+      return gnuradio::get_initial_sptr(new p25_frame_assembler_impl(silence_frames, soft_vocoder, udp_host, port, debug, do_imbe, do_output, do_msgq, queue, do_audio_output, do_phase2_tdma, do_nocrypt));
     }
 
     /*
@@ -95,13 +95,13 @@ static const int MAX_IN = 1;	// maximum number of input streams
 /*
  * The private constructor
  */
-  p25_frame_assembler_impl::p25_frame_assembler_impl(int silence_frames, const char *udp_host, int port, int debug, bool do_imbe, bool do_output, bool do_msgq, gr::msg_queue::sptr queue, bool do_audio_output, bool do_phase2_tdma, bool do_nocrypt)
+  p25_frame_assembler_impl::p25_frame_assembler_impl(int silence_frames,  bool soft_vocoder, const char *udp_host, int port, int debug, bool do_imbe, bool do_output, bool do_msgq, gr::msg_queue::sptr queue, bool do_audio_output, bool do_phase2_tdma, bool do_nocrypt)
       : gr::block("p25_frame_assembler",
 		   gr::io_signature::make (MIN_IN, MAX_IN, sizeof (char)),
 		   gr::io_signature::make ((do_output) ? 1 : 0, (do_output) ? 1 : 0, (do_audio_output && do_output) ? sizeof(int16_t) : ((do_output) ? sizeof(char) : 0 ))),
 	d_do_imbe(do_imbe),
 	d_do_output(do_output),
-  p1fdma(op25audio, logts, debug, do_imbe, do_output, do_msgq, queue, output_queue, do_audio_output),
+  p1fdma(op25audio, logts, debug, do_imbe, do_output, do_msgq, queue, output_queue, do_audio_output, soft_vocoder),
 	d_do_audio_output(do_audio_output),
 	d_do_phase2_tdma(do_phase2_tdma),
 	p2tdma(op25audio, logts,  0, debug, do_msgq, queue, output_queue, do_audio_output),
diff --git a/lib/op25_repeater/lib/p25_frame_assembler_impl.h b/lib/op25_repeater/lib/p25_frame_assembler_impl.h
@@ -76,7 +76,7 @@ namespace gr {
   void set_phase2_tdma(bool p);
 
 public:
-      p25_frame_assembler_impl(int silence_frames, const char* udp_host, int port, int debug, bool do_imbe, bool do_output, bool do_msgq, gr::msg_queue::sptr queue, bool do_audio_output, bool do_phase2_tdma, bool do_nocrypt);
+      p25_frame_assembler_impl(int silence_frames, bool soft_vocoder, const char* udp_host, int port, int debug, bool do_imbe, bool do_output, bool do_msgq, gr::msg_queue::sptr queue, bool do_audio_output, bool do_phase2_tdma, bool do_nocrypt);
       ~p25_frame_assembler_impl();
 
       op25_audio op25audio;
diff --git a/lib/op25_repeater/lib/p25p1_fdma.cc b/lib/op25_repeater/lib/p25p1_fdma.cc
@@ -198,7 +198,7 @@ namespace gr {
                 fprintf(stderr, "%s p25p1_fdma::set_nac: 0x%03x\n", logts.get(d_msgq_id), d_nac);
         }
 
-        p25p1_fdma::p25p1_fdma(const op25_audio& udp, log_ts& logger, int debug, bool do_imbe, bool do_output, bool do_msgq, gr::msg_queue::sptr queue, std::deque<int16_t> &output_queue, bool do_audio_output, int msgq_id) :
+        p25p1_fdma::p25p1_fdma(const op25_audio& udp, log_ts& logger, int debug, bool do_imbe, bool do_output, bool do_msgq, gr::msg_queue::sptr queue, std::deque<int16_t> &output_queue, bool do_audio_output, bool soft_vocoder, int msgq_id) :
             write_bufp(0),
             d_debug(debug),
             d_do_imbe(do_imbe),
@@ -208,6 +208,7 @@ namespace gr {
             d_do_audio_output(do_audio_output),
             d_nac(0),
             d_msg_queue(queue),
+            d_soft_vocoder(soft_vocoder),
             output_queue(output_queue),
             framer(new p25_framer(logger, debug, msgq_id)),
             qtimer(op25_timer(TIMEOUT_THRESHOLD)),
@@ -723,27 +724,31 @@ namespace gr {
                     if (d_do_audio_output) {
                         if ( !encrypted()) {
                             // This is the Vocoder that OP25 currently uses.
-                            /*software_decoder.decode_fullrate(u[0], u[1], u[2], u[3], u[4], u[5], u[6], u[7], E0, ET);
-                            audio_samples *samples = software_decoder.audio();
-                            for (int i=0; i < SND_FRAME; i++) {
-                           	    if (samples->size() > 0) {
-                       		        snd[i] = (int16_t)(samples->front());
-                                    samples->pop_front();
-                                } else {
-                                    snd[i] = 0;
+
+                            if (d_soft_vocoder) {
+                                // This is vocoder that is for half-rate
+                                software_decoder.decode_fullrate(u[0], u[1], u[2], u[3], u[4], u[5], u[6], u[7], E0, ET);
+                                audio_samples *samples = software_decoder.audio();
+                                for (int i=0; i < SND_FRAME; i++) {
+                                    if (samples->size() > 0) {
+                                        snd[i] = (int16_t)(samples->front());
+                                        samples->pop_front();
+                                    } else {
+                                        snd[i] = 0;
+                                    }
                                 }
-                            }*/
+                            } else {
 
-                            // This is the older, fullrate vocoder
-                            // it was copied from p25p1_voice_decode.cc
-                            int16_t frame_vector[8];
+                                // This is the older, fullrate vocoder
+                                // it was copied from p25p1_voice_decode.cc
+                                int16_t frame_vector[8];
 
-                            for (int i=0; i < 8; i++) { // Ugh. For compatibility convert imbe params from uint32_t to int16_t
-                                frame_vector[i] = u[i];
+                                for (int i=0; i < 8; i++) { // Ugh. For compatibility convert imbe params from uint32_t to int16_t
+                                    frame_vector[i] = u[i];
+                                }
+                                frame_vector[7] >>= 1;
+                                vocoder.imbe_decode(frame_vector, snd);
                             }
-                            frame_vector[7] >>= 1;
-                            vocoder.imbe_decode(frame_vector, snd);
-
 
                             if (op25audio.enabled()) {      // decoded audio goes out via UDP (normal code path)
                                 op25audio.send_audio(snd, SND_FRAME * sizeof(int16_t));
diff --git a/lib/op25_repeater/lib/p25p1_fdma.h b/lib/op25_repeater/lib/p25p1_fdma.h
@@ -80,6 +80,7 @@ namespace gr {
                 bool d_do_msgq;
                 int  d_msgq_id;
                 bool d_do_audio_output;
+                bool d_soft_vocoder;
                 int d_nac;
                 gr::msg_queue::sptr d_msg_queue;
                 std::deque<int16_t> &output_queue;
@@ -118,7 +119,7 @@ namespace gr {
                 void crypt_reset();
                 void crypt_key(uint16_t keyid, uint8_t algid, const std::vector<uint8_t> &key);
                 void rx_sym (const uint8_t *syms, int nsyms);
-                p25p1_fdma(const op25_audio& udp,  log_ts& logger, int debug, bool do_imbe, bool do_output, bool do_msgq, gr::msg_queue::sptr queue, std::deque<int16_t> &output_queue, bool do_audio_output, int msgq_id = 0);
+                p25p1_fdma(const op25_audio& udp,  log_ts& logger, int debug, bool do_imbe, bool do_output, bool do_msgq, gr::msg_queue::sptr queue, std::deque<int16_t> &output_queue, bool do_audio_output, bool soft_vocoder, int msgq_id = 0);
                 ~p25p1_fdma();
                 uint32_t load_nid(const uint8_t *syms, int nsyms, const uint64_t fs);
                 bool load_body(const uint8_t * syms, int nsyms);
diff --git a/lib/op25_repeater/lib/software_imbe_decoder.cc b/lib/op25_repeater/lib/software_imbe_decoder.cc
@@ -1593,7 +1593,7 @@ software_imbe_decoder::synth_voiced()
    }
 
    psi1 = psi1 +(Oldw0 + w0) * 80;
-   psi1 = remainderf(psi1, 2 * M_PI); // ToDo: decide if its 2pi or pi^2
+   psi1 = remainderf(psi1, 2 * M_PI); // ToDo: decide if its 2pi or pi^2 // YEP it should be 2pi
 
    for(ell = 1; ell <= L/4; ell++) {
       phi[ell][ New] = psi1 * ell;
diff --git a/trunk-recorder/global_structs.h b/trunk-recorder/global_structs.h
@@ -37,6 +37,7 @@ struct Config {
   int control_retune_limit;
   bool broadcast_signals;
   bool enable_audio_streaming;
+  bool soft_vocoder;
   bool record_uu_v_calls;
   int frequency_format;
 };
diff --git a/trunk-recorder/gr_blocks/decoders/tps_decoder_sink_impl.cc b/trunk-recorder/gr_blocks/decoders/tps_decoder_sink_impl.cc
@@ -224,7 +224,8 @@ void tps_decoder_sink_impl::initialize_p25() {
   bool do_audio_output = 0;
   bool do_tdma = 0;
   bool do_crypt = 0;
-  op25_frame_assembler = gr::op25_repeater::p25_frame_assembler::make(silence_frames, wireshark_host, udp_port, verbosity, do_imbe, do_output, do_msgq, rx_queue, do_audio_output, do_tdma, do_crypt);
+  bool soft_vocoder = false;
+  op25_frame_assembler = gr::op25_repeater::p25_frame_assembler::make(silence_frames, soft_vocoder, wireshark_host, udp_port, verbosity, do_imbe, do_output, do_msgq, rx_queue, do_audio_output, do_tdma, do_crypt);
 
   connect(self(), 0, valve, 0);
   connect(valve, 0, slicer, 0);
diff --git a/trunk-recorder/main.cc b/trunk-recorder/main.cc
@@ -232,6 +232,8 @@ bool load_config(string config_file) {
     BOOST_LOG_TRIVIAL(info) << "Control channel warning rate: " << config.control_message_warn_rate;
     config.control_retune_limit = pt.get<int>("controlRetuneLimit", 0);
     BOOST_LOG_TRIVIAL(info) << "Control channel retune limit: " << config.control_retune_limit;
+    config.soft_vocoder = pt.get<bool>("softVocoder", false);
+    BOOST_LOG_TRIVIAL(info) << "Phase 1 Software Vocoder: " << config.soft_vocoder;
     config.enable_audio_streaming = pt.get<bool>("audioStreaming", false);
     BOOST_LOG_TRIVIAL(info) << "Enable Audio Streaming: " << config.enable_audio_streaming;
     config.record_uu_v_calls = pt.get<bool>("recordUUVCalls", true);
diff --git a/trunk-recorder/recorders/p25_recorder_decode.cc b/trunk-recorder/recorders/p25_recorder_decode.cc
@@ -3,9 +3,9 @@
 #include "../gr_blocks/plugin_wrapper_impl.h"
 #include "../plugin_manager/plugin_manager.h"
 
-p25_recorder_decode_sptr make_p25_recorder_decode(Recorder *recorder, int silence_frames) {
+p25_recorder_decode_sptr make_p25_recorder_decode(Recorder *recorder, int silence_frames, bool d_soft_vocoder) {
   p25_recorder_decode *decoder = new p25_recorder_decode(recorder);
-  decoder->initialize(silence_frames);
+  decoder->initialize(silence_frames, d_soft_vocoder);
   return gnuradio::get_initial_sptr(decoder);
 }
 
@@ -65,7 +65,7 @@ void p25_recorder_decode::switch_tdma(bool phase2_tdma) {
   op25_frame_assembler->set_phase2_tdma(phase2_tdma);
 }
 
-void p25_recorder_decode::initialize(int silence_frames) {
+void p25_recorder_decode::initialize(int silence_frames, bool d_soft_vocoder) {
   // OP25 Slicer
   const float l[] = {-2.0, 0.0, 2.0, 4.0};
   std::vector<float> slices(l, l + sizeof(l) / sizeof(l[0]));
@@ -91,7 +91,7 @@ void p25_recorder_decode::initialize(int silence_frames) {
   bool do_tdma = 0;
   bool do_nocrypt = 1;
 
-  op25_frame_assembler = gr::op25_repeater::p25_frame_assembler::make(silence_frames, udp_host, udp_port, verbosity, do_imbe, do_output, do_msgq, rx_queue, do_audio_output, do_tdma, do_nocrypt);
+  op25_frame_assembler = gr::op25_repeater::p25_frame_assembler::make(silence_frames, d_soft_vocoder, udp_host, udp_port, verbosity, do_imbe, do_output, do_msgq, rx_queue, do_audio_output, do_tdma, do_nocrypt);
   levels = gr::blocks::multiply_const_ss::make(1);
 
   if (use_streaming) {
diff --git a/trunk-recorder/recorders/p25_recorder_decode.h b/trunk-recorder/recorders/p25_recorder_decode.h
@@ -35,13 +35,13 @@ typedef boost::shared_ptr<p25_recorder_decode> p25_recorder_decode_sptr;
 typedef std::shared_ptr<p25_recorder_decode> p25_recorder_decode_sptr;
 #endif
 
-p25_recorder_decode_sptr make_p25_recorder_decode(Recorder *recorder, int silence_frames);
+p25_recorder_decode_sptr make_p25_recorder_decode(Recorder *recorder, int silence_frames, bool d_soft_vocoder);
 
 class p25_recorder_decode : public gr::hier_block2 {
-  friend p25_recorder_decode_sptr make_p25_recorder_decode(Recorder *recorder, int silence_frames);
+  friend p25_recorder_decode_sptr make_p25_recorder_decode(Recorder *recorder, int silence_frames, bool d_soft_vocoder);
 
 protected:
-  virtual void initialize(int silence_frames);
+  virtual void initialize(int silence_frames, bool d_soft_vocoder);
   Recorder *d_recorder;
   Call *d_call;
   gr::op25_repeater::p25_frame_assembler::sptr op25_frame_assembler;
diff --git a/trunk-recorder/recorders/p25_recorder_impl.cc b/trunk-recorder/recorders/p25_recorder_impl.cc
@@ -185,6 +185,7 @@ void p25_recorder_impl::initialize(Source *src) {
   chan_freq = source->get_center();
   center_freq = source->get_center();
   config = source->get_config();
+  d_soft_vocoder = config->soft_vocoder;
   input_rate = source->get_rate();
   qpsk_mod = true;
   silence_frames = source->get_silence_frames();
@@ -211,9 +212,9 @@ void p25_recorder_impl::initialize(Source *src) {
 
   modulation_selector = gr::blocks::selector::make(sizeof(gr_complex), 0, 0);
   qpsk_demod = make_p25_recorder_qpsk_demod();
-  qpsk_p25_decode = make_p25_recorder_decode(this, silence_frames);
+  qpsk_p25_decode = make_p25_recorder_decode(this, silence_frames, d_soft_vocoder);
   fsk4_demod = make_p25_recorder_fsk4_demod();
-  fsk4_p25_decode = make_p25_recorder_decode(this, silence_frames);
+  fsk4_p25_decode = make_p25_recorder_decode(this, silence_frames, d_soft_vocoder);
 
   modulation_selector->set_enabled(true);
 
diff --git a/trunk-recorder/recorders/p25_recorder_impl.h b/trunk-recorder/recorders/p25_recorder_impl.h
@@ -149,6 +149,7 @@ class p25_recorder_impl : public p25_recorder {
   int silence_frames;
   int tdma_slot;
   bool d_phase2_tdma;
+  bool d_soft_vocoder;
   bool double_decim;
   long if1;
   long if2;
diff --git a/trunk-recorder/source.cc b/trunk-recorder/source.cc
@@ -29,6 +29,7 @@ int Source::get_silence_frames() {
   return silence_frames;
 }
 
+
 double Source::get_min_hz() {
   return min_hz;
 }
diff --git a/trunk-recorder/systems/p25_trunking.cc b/trunk-recorder/systems/p25_trunking.cc
@@ -259,7 +259,8 @@ void p25_trunking::initialize_p25() {
   bool do_audio_output = 0;
   bool do_tdma = 0;
   bool do_nocrypt = 1;
-  op25_frame_assembler = gr::op25_repeater::p25_frame_assembler::make(silence_frames, wireshark_host, udp_port, verbosity, do_imbe, do_output, do_msgq, rx_queue, do_audio_output, do_tdma, do_nocrypt);
+  bool soft_vocoder = false;
+  op25_frame_assembler = gr::op25_repeater::p25_frame_assembler::make(silence_frames, soft_vocoder, wireshark_host, udp_port, verbosity, do_imbe, do_output, do_msgq, rx_queue, do_audio_output, do_tdma, do_nocrypt);
 
   connect(slicer, 0, op25_frame_assembler, 0);
 }

Original file line number	Diff line number	Diff line change
`@@ -1593,7 +1593,7 @@ software_imbe_decoder::synth_voiced()`
`1593`	`1593`	`}`
`1594`	`1594`
`1595`	`1595`	`psi1 = psi1 +(Oldw0 + w0) * 80;`
`1596`		`- psi1 = remainderf(psi1, 2 * M_PI); // ToDo: decide if its 2pi or pi^2`
	`1596`	`+ psi1 = remainderf(psi1, 2 * M_PI); // ToDo: decide if its 2pi or pi^2 // YEP it should be 2pi`
`1597`	`1597`
`1598`	`1598`	`for(ell = 1; ell <= L/4; ell++) {`
`1599`	`1599`	`phi[ell][ New] = psi1 * ell;`