#1584 Updates DMR & P25 decoders to stop processing residual samples from the current buffer after a traffic channel shutdown has been signalled. (#1585)

DSheirer · Dennis Sheirer · web-flow · commit bac38a5bd852 · 2023-06-25T03:56:08.000-04:00
Co-authored-by: Dennis Sheirer &lt;dsheirer@github.com&gt;
diff --git a/src/main/java/io/github/dsheirer/dsp/psk/PSKDemodulator.java b/src/main/java/io/github/dsheirer/dsp/psk/PSKDemodulator.java
@@ -1,6 +1,6 @@
 /*
  * *****************************************************************************
- * Copyright (C) 2014-2022 Dennis Sheirer
+ * Copyright (C) 2014-2023 Dennis Sheirer
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -30,6 +30,7 @@ public abstract class PSKDemodulator<T> implements ComplexSampleListener
     private IPhaseLockedLoop mPLL;
     private Complex mReceivedSample = new Complex(0, 0);
     private Listener<T> mSymbolListener;
+    private boolean mRunning;
 
     /**
      * Abstract Phase Shift Keyed (PSK) demodulator
@@ -42,6 +43,31 @@ public PSKDemodulator(InterpolatingSampleBuffer interpolatingSampleBuffer, IPhas
         mPLL = phaseLockedLoop;
     }
 
+    /**
+     * Starts this decoder and sets the running flag to true
+     */
+    public void start()
+    {
+        mRunning = true;
+    }
+
+    /**
+     * Stops this decoder and sets the running flag to false.
+     */
+    public void stop()
+    {
+        mRunning = false;
+    }
+
+    /**
+     * Indicates if this demodulator is running and capable of processing samples
+     * @return true if running
+     */
+    public boolean isRunning()
+    {
+        return mRunning;
+    }
+
     /**
      * Registers the listener to receive symbol decisions from this demodulator
      */
@@ -90,7 +116,10 @@ public void receive(ComplexSamples samples)
 
         for(int x = 0; x < i.length; x++)
         {
-            receive(i[x], q[x]);
+            if(isRunning())
+            {
+                receive(i[x], q[x]);
+            }
         }
     }
 
diff --git a/src/main/java/io/github/dsheirer/module/decode/Decoder.java b/src/main/java/io/github/dsheirer/module/decode/Decoder.java
@@ -1,6 +1,6 @@
 /*
  * *****************************************************************************
- * Copyright (C) 2014-2022 Dennis Sheirer
+ * Copyright (C) 2014-2023 Dennis Sheirer
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -23,11 +23,14 @@
 import io.github.dsheirer.module.Module;
 import io.github.dsheirer.sample.Listener;
 
+/**
+ * Base decoder class.
+ */
 public abstract class Decoder extends Module implements IMessageProvider
 {
-    /* This has to be a broadcaster in order for references to persist */
     private Listener<IMessage> mMessageDistributor = new MessageDistributor();
     protected Listener<IMessage> mMessageListener;
+    private boolean mRunning;
 
     /**
      * Decoder - parent class for all decoders, demodulators and components.
@@ -36,14 +39,29 @@ public Decoder()
     {
     }
 
+    /**
+     * Starts this decoder and sets the running flag to true.
+     */
     public void start()
     {
-        //no-op
+        mRunning = true;
     }
 
+    /**
+     * Stops this decoder and sets the running flag to false.
+     */
     public void stop()
     {
-        //no-op
+        mRunning = false;
+    }
+
+    /**
+     * Indicates if this decoder is currently started and in a running state.
+     * @return true if running or false if not.
+     */
+    public boolean isRunning()
+    {
+        return mRunning;
     }
 
     public void reset()
diff --git a/src/main/java/io/github/dsheirer/module/decode/dmr/DMRDecoder.java b/src/main/java/io/github/dsheirer/module/decode/dmr/DMRDecoder.java
@@ -1,6 +1,6 @@
 /*
  * *****************************************************************************
- * Copyright (C) 2014-2022 Dennis Sheirer
+ * Copyright (C) 2014-2023 Dennis Sheirer
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -84,6 +84,20 @@ public DMRDecoder(DecodeConfigDMR config)
         setSampleRate(25000.0);
     }
 
+    @Override
+    public void start()
+    {
+        super.start();
+        mQPSKDemodulator.start();
+    }
+
+    @Override
+    public void stop()
+    {
+        super.stop();
+        mQPSKDemodulator.stop();
+    }
+
     /**
      * DMR decoder type.
      */
@@ -318,22 +332,4 @@ public Listener<ComplexSamples> getComplexSamplesListener()
     {
         return DMRDecoder.this;
     }
-
-    /**
-     * Starts the decoder
-     */
-    @Override
-    public void start()
-    {
-        //No-op
-    }
-
-    /**
-     * Stops the decoder
-     */
-    @Override
-    public void stop()
-    {
-        //No-op
-    }
 }
diff --git a/src/main/java/io/github/dsheirer/module/decode/p25/phase1/P25P1Decoder.java b/src/main/java/io/github/dsheirer/module/decode/p25/phase1/P25P1Decoder.java
@@ -1,6 +1,6 @@
 /*
  * *****************************************************************************
- * Copyright (C) 2014-2022 Dennis Sheirer
+ * Copyright (C) 2014-2023 Dennis Sheirer
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -31,7 +31,6 @@
 import io.github.dsheirer.source.ISourceEventListener;
 import io.github.dsheirer.source.ISourceEventProvider;
 import io.github.dsheirer.source.SourceEvent;
-
 import java.nio.ByteBuffer;
 
 public abstract class P25P1Decoder extends FeedbackDecoder implements ISourceEventListener, ISourceEventProvider,
@@ -166,24 +165,6 @@ public Listener<ComplexSamples> getComplexSamplesListener()
         return P25P1Decoder.this;
     }
 
-    /**
-     * Starts the decoder
-     */
-    @Override
-    public void start()
-    {
-        //No-op
-    }
-
-    /**
-     * Stops the decoder
-     */
-    @Override
-    public void stop()
-    {
-        //No-op
-    }
-
     @Override
     public DecoderType getDecoderType()
     {
diff --git a/src/main/java/io/github/dsheirer/module/decode/p25/phase1/P25P1DecoderC4FM.java b/src/main/java/io/github/dsheirer/module/decode/p25/phase1/P25P1DecoderC4FM.java
@@ -1,6 +1,6 @@
 /*
  * *****************************************************************************
- * Copyright (C) 2014-2022 Dennis Sheirer
+ * Copyright (C) 2014-2023 Dennis Sheirer
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -62,6 +62,20 @@ public P25P1DecoderC4FM()
         setSampleRate(25000.0);
     }
 
+    @Override
+    public void start()
+    {
+        super.start();
+        mQPSKDemodulator.start();
+    }
+
+    @Override
+    public void stop()
+    {
+        super.stop();
+        mQPSKDemodulator.stop();
+    }
+
     public void setSampleRate(double sampleRate)
     {
         super.setSampleRate(sampleRate);
diff --git a/src/main/java/io/github/dsheirer/module/decode/p25/phase1/P25P1DecoderLSM.java b/src/main/java/io/github/dsheirer/module/decode/p25/phase1/P25P1DecoderLSM.java
@@ -1,6 +1,6 @@
 /*
  * *****************************************************************************
- * Copyright (C) 2014-2022 Dennis Sheirer
+ * Copyright (C) 2014-2023 Dennis Sheirer
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -62,6 +62,20 @@ public P25P1DecoderLSM()
         setSampleRate(25000.0);
     }
 
+    @Override
+    public void start()
+    {
+        super.start();
+        mQPSKDemodulator.start();
+    }
+
+    @Override
+    public void stop()
+    {
+        super.stop();
+        mQPSKDemodulator.stop();
+    }
+
     /**
      * Sets or changes the channel sample rate
      *
diff --git a/src/main/java/io/github/dsheirer/module/decode/p25/phase2/P25P2Decoder.java b/src/main/java/io/github/dsheirer/module/decode/p25/phase2/P25P2Decoder.java
@@ -1,6 +1,6 @@
 /*
  * *****************************************************************************
- * Copyright (C) 2014-2022 Dennis Sheirer
+ * Copyright (C) 2014-2023 Dennis Sheirer
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -31,7 +31,6 @@
 import io.github.dsheirer.source.ISourceEventListener;
 import io.github.dsheirer.source.ISourceEventProvider;
 import io.github.dsheirer.source.SourceEvent;
-
 import java.nio.ByteBuffer;
 
 /**
@@ -169,24 +168,6 @@ public Listener<ComplexSamples> getComplexSamplesListener()
         return P25P2Decoder.this;
     }
 
-    /**
-     * Starts the decoder
-     */
-    @Override
-    public void start()
-    {
-        //No-op
-    }
-
-    /**
-     * Stops the decoder
-     */
-    @Override
-    public void stop()
-    {
-        //No-op
-    }
-
     @Override
     public DecoderType getDecoderType()
     {
diff --git a/src/main/java/io/github/dsheirer/module/decode/p25/phase2/P25P2DecoderHDQPSK.java b/src/main/java/io/github/dsheirer/module/decode/p25/phase2/P25P2DecoderHDQPSK.java
@@ -1,6 +1,6 @@
 /*
  * *****************************************************************************
- * Copyright (C) 2014-2022 Dennis Sheirer
+ * Copyright (C) 2014-2023 Dennis Sheirer
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -67,6 +67,27 @@ public P25P2DecoderHDQPSK(DecodeConfigP25Phase2 decodeConfigP25Phase2)
         mDecodeConfigP25Phase2 = decodeConfigP25Phase2;
     }
 
+    @Override
+    public void start()
+    {
+        super.start();
+        mQPSKDemodulator.start();
+
+        //Refresh the scramble parameters each time we start in case they change
+        if(mDecodeConfigP25Phase2 != null && mDecodeConfigP25Phase2.getScrambleParameters() != null &&
+                !mDecodeConfigP25Phase2.isAutoDetectScrambleParameters())
+        {
+            mMessageFramer.setScrambleParameters(mDecodeConfigP25Phase2.getScrambleParameters());
+        }
+    }
+
+    @Override
+    public void stop()
+    {
+        super.stop();
+        mQPSKDemodulator.stop();
+    }
+
     public void setSampleRate(double sampleRate)
     {
         super.setSampleRate(sampleRate);
@@ -188,19 +209,6 @@ public void reset()
         mCostasLoop.reset();
     }
 
-    @Override
-    public void start()
-    {
-        super.start();
-
-        //Refresh the scramble parameters each time we start in case they change
-        if(mDecodeConfigP25Phase2 != null && mDecodeConfigP25Phase2.getScrambleParameters() != null &&
-            !mDecodeConfigP25Phase2.isAutoDetectScrambleParameters())
-        {
-            mMessageFramer.setScrambleParameters(mDecodeConfigP25Phase2.getScrambleParameters());
-        }
-    }
-
     @Override
     public Listener<IdentifierUpdateNotification> getIdentifierUpdateListener()
     {
