#817 Resolves issue with jittery audio playback and recording for MPT1327 channels. (#830)

Co-authored-by: Denny <denny@denny-desktop>
This commit is contained in:
Denny Sheirer
2020-05-24 07:58:59 -04:00
committed by GitHub
parent 3d816c3570
commit 2c3648f8c2
11 changed files with 131 additions and 52 deletions

View File

@@ -49,11 +49,14 @@ public abstract class AbstractAudioModule extends Module implements IAudioSegmen
/** /**
* Constructs an abstract audio module * Constructs an abstract audio module
*
* @param aliasList for aliasing identifiers
* @param maxSegmentAudioSampleLength in milliseconds
*/ */
public AbstractAudioModule(AliasList aliasList, int maxSegmentAudioSampleLength) public AbstractAudioModule(AliasList aliasList, long maxSegmentAudioSampleLength)
{ {
mAliasList = aliasList; mAliasList = aliasList;
mMaxSegmentAudioSampleLength = maxSegmentAudioSampleLength; mMaxSegmentAudioSampleLength = (int)(maxSegmentAudioSampleLength * 8); //Convert milliseconds to samples
mIdentifierUpdateNotificationBroadcaster.addListener(mIdentifierCollection); mIdentifierUpdateNotificationBroadcaster.addListener(mIdentifierCollection);
} }

View File

@@ -79,10 +79,13 @@ public class AudioModule extends AbstractAudioModule implements ISquelchStateLis
/** /**
* Creates an Audio Module. * Creates an Audio Module.
*
* @param aliasList for aliasing identifiers
* @param maxAudioSegmentLength in milliseconds
*/ */
public AudioModule(AliasList aliasList, int maxSegmentAudioSampleLength) public AudioModule(AliasList aliasList, long maxAudioSegmentLength)
{ {
super(aliasList, maxSegmentAudioSampleLength); super(aliasList, maxAudioSegmentLength);
} }
/** /**
@@ -124,17 +127,17 @@ public class AudioModule extends AbstractAudioModule implements ISquelchStateLis
} }
@Override @Override
public void receive(ReusableFloatBuffer reusableFloatBuffer) public void receive(ReusableFloatBuffer audioBuffer)
{ {
if(mSquelchState == SquelchState.UNSQUELCH) if(mSquelchState == SquelchState.UNSQUELCH)
{ {
ReusableFloatBuffer buffer = mHighPassFilter.filter(reusableFloatBuffer); ReusableFloatBuffer highPassFilteredAudio = mHighPassFilter.filter(audioBuffer);
addAudio(buffer.getSamples()); addAudio(highPassFilteredAudio.getSamplesCopy());
buffer.decrementUserCount(); highPassFilteredAudio.decrementUserCount();
} }
else else
{ {
reusableFloatBuffer.decrementUserCount(); audioBuffer.decrementUserCount();
} }
} }

View File

@@ -30,15 +30,28 @@ import io.github.dsheirer.controller.channel.Channel.ChannelType;
public class ChangeChannelTimeoutEvent extends DecoderStateEvent public class ChangeChannelTimeoutEvent extends DecoderStateEvent
{ {
private ChannelType mChannelType; private ChannelType mChannelType;
private long mCallTimeout; private long mCallTimeoutMilliseconds;
/**
* Constructs an instance
* @param source of the event
* @param channelType for the event
* @param timeout in milliseconds
* @param timeslot of the event
*/
public ChangeChannelTimeoutEvent(Object source, ChannelType channelType, long timeout, int timeslot) public ChangeChannelTimeoutEvent(Object source, ChannelType channelType, long timeout, int timeslot)
{ {
super(source, Event.CHANGE_CALL_TIMEOUT, State.IDLE, timeslot); super(source, Event.CHANGE_CALL_TIMEOUT, State.IDLE, timeslot);
mChannelType = channelType; mChannelType = channelType;
mCallTimeout = timeout; mCallTimeoutMilliseconds = timeout;
} }
/**
* Constructs an instance
* @param source of the event
* @param channelType for the event
* @param timeout value in milliseconds
*/
public ChangeChannelTimeoutEvent(Object source, ChannelType channelType, long timeout) public ChangeChannelTimeoutEvent(Object source, ChannelType channelType, long timeout)
{ {
this(source, channelType, timeout, 0); this(source, channelType, timeout, 0);
@@ -49,8 +62,11 @@ public class ChangeChannelTimeoutEvent extends DecoderStateEvent
return mChannelType; return mChannelType;
} }
public long getCallTimeout() /**
* Call timeout value in milliseconds
*/
public long getCallTimeoutMilliseconds()
{ {
return mCallTimeout; return mCallTimeoutMilliseconds;
} }
} }

View File

@@ -115,14 +115,14 @@ public class MultiChannelState extends AbstractChannelState implements IDecoderS
stateMachine.setChannelType(mChannel.getChannelType()); stateMachine.setChannelType(mChannel.getChannelType());
stateMachine.setIdentifierUpdateListener(mutableIdentifierCollection); stateMachine.setIdentifierUpdateListener(mutableIdentifierCollection);
stateMachine.setEndTimeoutBuffer(RESET_TIMEOUT_DELAY); stateMachine.setEndTimeoutBufferMilliseconds(RESET_TIMEOUT_DELAY);
if(channel.getChannelType() == ChannelType.STANDARD) if(channel.getChannelType() == ChannelType.STANDARD)
{ {
stateMachine.setFadeTimeoutBuffer(FADE_TIMEOUT_DELAY); stateMachine.setFadeTimeoutBufferMilliseconds(FADE_TIMEOUT_DELAY);
} }
else else
{ {
stateMachine.setFadeTimeoutBuffer(DecodeConfiguration.DEFAULT_CALL_TIMEOUT_DELAY_SECONDS * 1000); stateMachine.setFadeTimeoutBufferMilliseconds(DecodeConfiguration.DEFAULT_CALL_TIMEOUT_DELAY_SECONDS * 1000);
} }
} }
@@ -529,7 +529,7 @@ public class MultiChannelState extends AbstractChannelState implements IDecoderS
if(event instanceof ChangeChannelTimeoutEvent) if(event instanceof ChangeChannelTimeoutEvent)
{ {
ChangeChannelTimeoutEvent timeout = (ChangeChannelTimeoutEvent)event; ChangeChannelTimeoutEvent timeout = (ChangeChannelTimeoutEvent)event;
mStateMachineMap.get(event.getTimeslot()).setFadeTimeoutBuffer(timeout.getCallTimeout()); mStateMachineMap.get(event.getTimeslot()).setFadeTimeoutBufferMilliseconds(timeout.getCallTimeoutMilliseconds());
} }
break; break;
case CONTINUATION: case CONTINUATION:

View File

@@ -109,19 +109,19 @@ public class SingleChannelState extends AbstractChannelState implements IDecoder
mStateMachine.addListener(mSquelchController); mStateMachine.addListener(mSquelchController);
mStateMachine.setChannelType(mChannel.getChannelType()); mStateMachine.setChannelType(mChannel.getChannelType());
mStateMachine.setIdentifierUpdateListener(mIdentifierCollection); mStateMachine.setIdentifierUpdateListener(mIdentifierCollection);
mStateMachine.setEndTimeoutBuffer(RESET_TIMEOUT_DELAY); mStateMachine.setEndTimeoutBufferMilliseconds(RESET_TIMEOUT_DELAY);
if(channel.getChannelType() == ChannelType.STANDARD) if(channel.getChannelType() == ChannelType.STANDARD)
{ {
mStateMachine.setFadeTimeoutBuffer(FADE_TIMEOUT_DELAY); mStateMachine.setFadeTimeoutBufferMilliseconds(FADE_TIMEOUT_DELAY);
} }
else else
{ {
final DecodeConfiguration decodeConfig = channel.getDecodeConfiguration(); final DecodeConfiguration decodeConfig = channel.getDecodeConfiguration();
final int fadeTimeoutSeconds = decodeConfig instanceof WithCallTimeout final int fadeTimeoutSeconds = decodeConfig instanceof WithCallTimeout
? ((WithCallTimeout) decodeConfig).getCallTimeout() ? ((WithCallTimeout) decodeConfig).getCallTimeoutSeconds()
: DecodeConfiguration.DEFAULT_CALL_TIMEOUT_DELAY_SECONDS; : DecodeConfiguration.DEFAULT_CALL_TIMEOUT_DELAY_SECONDS;
mStateMachine.setFadeTimeoutBuffer(fadeTimeoutSeconds * 1000); mStateMachine.setFadeTimeoutBufferMilliseconds(fadeTimeoutSeconds * 1000);
} }
} }
@@ -412,7 +412,7 @@ public class SingleChannelState extends AbstractChannelState implements IDecoder
if(event instanceof ChangeChannelTimeoutEvent) if(event instanceof ChangeChannelTimeoutEvent)
{ {
ChangeChannelTimeoutEvent timeout = (ChangeChannelTimeoutEvent)event; ChangeChannelTimeoutEvent timeout = (ChangeChannelTimeoutEvent)event;
mStateMachine.setFadeTimeoutBuffer(timeout.getCallTimeout()); mStateMachine.setFadeTimeoutBufferMilliseconds(timeout.getCallTimeoutMilliseconds());
} }
case CONTINUATION: case CONTINUATION:
case DECODE: case DECODE:

View File

@@ -42,9 +42,9 @@ public class StateMachine
protected State mState = State.IDLE; protected State mState = State.IDLE;
protected long mFadeTimeout; protected long mFadeTimeout;
protected long mFadeTimeoutBuffer = 0; protected long mFadeTimeoutBufferMilliseconds = 0;
protected long mEndTimeout; protected long mEndTimeout;
protected long mEndTimeoutBuffer = 0; protected long mEndTimeoutBufferMilliseconds = 0;
private int mTimeslot; private int mTimeslot;
private EnumSet<State> mActiveStates; private EnumSet<State> mActiveStates;
private Channel.ChannelType mChannelType = Channel.ChannelType.STANDARD; private Channel.ChannelType mChannelType = Channel.ChannelType.STANDARD;
@@ -63,26 +63,42 @@ public class StateMachine
mActiveStates = activeStates; mActiveStates = activeStates;
} }
/**
* Adds a state change listener
* @param listener to receive state change events
*/
public void addListener(IStateMachineListener listener) public void addListener(IStateMachineListener listener)
{ {
mStateMachineListeners.add(listener); mStateMachineListeners.add(listener);
} }
/**
* Removes the state change listener
*/
public void removeListener(IStateMachineListener listener) public void removeListener(IStateMachineListener listener)
{ {
mStateMachineListeners.remove(listener); mStateMachineListeners.remove(listener);
} }
/**
* Sets the listener to receive identifier update notifications (ie state identifier updates)
*/
public void setIdentifierUpdateListener(Listener<IdentifierUpdateNotification> listener) public void setIdentifierUpdateListener(Listener<IdentifierUpdateNotification> listener)
{ {
mIdentifierUpdateListener = listener; mIdentifierUpdateListener = listener;
} }
/**
* Sets the channel type for this state machine
*/
public void setChannelType(Channel.ChannelType channelType) public void setChannelType(Channel.ChannelType channelType)
{ {
mChannelType = channelType; mChannelType = channelType;
} }
/**
* Checks the state and transitions to FADE or TEARDOWN if timers have expired
*/
public void checkState() public void checkState()
{ {
if(mActiveStates.contains(mState) && mFadeTimeout <= System.currentTimeMillis()) if(mActiveStates.contains(mState) && mFadeTimeout <= System.currentTimeMillis())
@@ -95,11 +111,17 @@ public class StateMachine
} }
} }
/**
* Current state of the state machine
*/
public State getState() public State getState()
{ {
return mState; return mState;
} }
/**
* Sets the state
*/
public void setState(State state) public void setState(State state)
{ {
if(state == mState) if(state == mState)
@@ -173,6 +195,9 @@ public class StateMachine
} }
} }
/**
* Broadcasts a channel state identifier update
*/
private void broadcast(ChannelStateIdentifier channelStateIdentifier) private void broadcast(ChannelStateIdentifier channelStateIdentifier)
{ {
if(mIdentifierUpdateListener != null) if(mIdentifierUpdateListener != null)
@@ -182,43 +207,70 @@ public class StateMachine
} }
} }
/**
* Updates the fade timeout to current time plus the fade timeout buffer value.
*/
private void updateFadeTimeout() private void updateFadeTimeout()
{ {
mFadeTimeout = System.currentTimeMillis() + mFadeTimeoutBuffer; mFadeTimeout = System.currentTimeMillis() + mFadeTimeoutBufferMilliseconds;
} }
/**
* Manually sets the fade timeout
*/
public void setFadeTimeout(long timeout) public void setFadeTimeout(long timeout)
{ {
mFadeTimeout = timeout; mFadeTimeout = timeout;
} }
/**
* Fade timeout value
*/
public long getFadeTimeout() public long getFadeTimeout()
{ {
return mFadeTimeout; return mFadeTimeout;
} }
public void setFadeTimeoutBuffer(long buffer) /**
* Sets the fade timeout buffer value. This value determines the maximum length of time the state machine
* can stay in any state (without an update) before automatically transitioning to FADE state.
* @param buffer in milliseconds
*/
public void setFadeTimeoutBufferMilliseconds(long buffer)
{ {
mFadeTimeoutBuffer = buffer; mFadeTimeoutBufferMilliseconds = buffer;
updateFadeTimeout(); updateFadeTimeout();
} }
/**
* Updates the end timeout value to current system time plus the end timeout buffer value.
*/
private void updateEndTimeout() private void updateEndTimeout()
{ {
mEndTimeout = System.currentTimeMillis() + mEndTimeoutBuffer; mEndTimeout = System.currentTimeMillis() + mEndTimeoutBufferMilliseconds;
} }
public void setEndTimeoutBuffer(long buffer) /**
* Sets the end timeout buffer value. This value is the maximum length of time that the channel can
* stay in the FADE state (without an update) before transitioning to a TEARDOWN state.
*/
public void setEndTimeoutBufferMilliseconds(long buffer)
{ {
mEndTimeoutBuffer = buffer; mEndTimeoutBufferMilliseconds = buffer;
updateEndTimeout(); updateEndTimeout();
} }
/**
* Sets the end timeout value
*/
public void setEndTimeout(long endTimeout) public void setEndTimeout(long endTimeout)
{ {
mEndTimeout = endTimeout; mEndTimeout = endTimeout;
} }
/**
* Current end timeout value
*/
public long getEndTimeout() public long getEndTimeout()
{ {
return mEndTimeout; return mEndTimeout;

View File

@@ -343,7 +343,7 @@ public class MPT1327ConfigurationEditor extends ChannelConfigurationEditor
} }
} }
int callTimeout = decodeConfigMPT1327.getCallTimeout(); int callTimeout = decodeConfigMPT1327.getCallTimeoutSeconds();
getCallTimeoutSpinner().getValueFactory().setValue(callTimeout); getCallTimeoutSpinner().getValueFactory().setValue(callTimeout);
int channelPoolSize = decodeConfigMPT1327.getTrafficChannelPoolSize(); int channelPoolSize = decodeConfigMPT1327.getTrafficChannelPoolSize();
@@ -370,7 +370,7 @@ public class MPT1327ConfigurationEditor extends ChannelConfigurationEditor
config = new DecodeConfigMPT1327(); config = new DecodeConfigMPT1327();
} }
config.setCallTimeout(getCallTimeoutSpinner().getValue()); config.setCallTimeoutSeconds(getCallTimeoutSpinner().getValue());
config.setTrafficChannelPoolSize(getTrafficChannelPoolSizeSpinner().getValue()); config.setTrafficChannelPoolSize(getTrafficChannelPoolSizeSpinner().getValue());
ChannelMap selected = getChannelMapComboBox().getSelectionModel().getSelectedItem(); ChannelMap selected = getChannelMapComboBox().getSelectionModel().getSelectedItem();

View File

@@ -227,11 +227,13 @@ public class DecoderFactory
Sync sync = mptConfig.getSync(); Sync sync = mptConfig.getSync();
modules.add(new MPT1327Decoder(sync)); modules.add(new MPT1327Decoder(sync));
final int timeout = mptConfig.getCallTimeout() * 1000; final int callTimeoutMilliseconds = mptConfig.getCallTimeoutSeconds() * 1000;
// Set max segment audio sample length slightly above call timeout to // Set max segment audio sample length slightly above call timeout to
// not create a new segment if the processing chain finishes a bit after // not create a new segment if the processing chain finishes a bit after
// actual call timeout. // actual call timeout.
modules.add(new AudioModule(aliasList, timeout + 5000)); int maxAudioSegmentLengthMillis = (callTimeoutMilliseconds + 5000);
modules.add(new AudioModule(aliasList, maxAudioSegmentLengthMillis));
SourceType sourceType = channel.getSourceConfiguration().getSourceType(); SourceType sourceType = channel.getSourceConfiguration().getSourceType();
if(sourceType == SourceType.TUNER || sourceType == SourceType.TUNER_MULTIPLE_FREQUENCIES) if(sourceType == SourceType.TUNER || sourceType == SourceType.TUNER_MULTIPLE_FREQUENCIES)
@@ -243,11 +245,11 @@ public class DecoderFactory
{ {
MPT1327TrafficChannelManager trafficChannelManager = new MPT1327TrafficChannelManager(channel, channelMap); MPT1327TrafficChannelManager trafficChannelManager = new MPT1327TrafficChannelManager(channel, channelMap);
modules.add(trafficChannelManager); modules.add(trafficChannelManager);
modules.add(new MPT1327DecoderState(trafficChannelManager, channelType, timeout)); modules.add(new MPT1327DecoderState(trafficChannelManager, channelType, callTimeoutMilliseconds));
} }
else else
{ {
modules.add(new MPT1327DecoderState(channelType, timeout)); modules.add(new MPT1327DecoderState(channelType, callTimeoutMilliseconds));
} }
//Add a channel rotation monitor when we have multiple control channel frequencies specified //Add a channel rotation monitor when we have multiple control channel frequencies specified
@@ -483,7 +485,7 @@ public class DecoderFactory
case MPT1327: case MPT1327:
DecodeConfigMPT1327 originalMPT = (DecodeConfigMPT1327)config; DecodeConfigMPT1327 originalMPT = (DecodeConfigMPT1327)config;
DecodeConfigMPT1327 copyMPT = new DecodeConfigMPT1327(); DecodeConfigMPT1327 copyMPT = new DecodeConfigMPT1327();
copyMPT.setCallTimeout(originalMPT.getCallTimeout()); copyMPT.setCallTimeoutSeconds(originalMPT.getCallTimeoutSeconds());
copyMPT.setChannelMapName(originalMPT.getChannelMapName()); copyMPT.setChannelMapName(originalMPT.getChannelMapName());
copyMPT.setSync(originalMPT.getSync()); copyMPT.setSync(originalMPT.getSync());
copyMPT.setTrafficChannelPoolSize(originalMPT.getTrafficChannelPoolSize()); copyMPT.setTrafficChannelPoolSize(originalMPT.getTrafficChannelPoolSize());

View File

@@ -30,5 +30,5 @@ public interface WithCallTimeout
/** /**
* @return call timeout in seconds * @return call timeout in seconds
*/ */
int getCallTimeout(); int getCallTimeoutSeconds();
} }

View File

@@ -33,7 +33,7 @@ public class DecodeConfigMPT1327 extends DecodeConfiguration implements WithCall
private String mChannelMapName; private String mChannelMapName;
private Sync mSync = Sync.NORMAL; private Sync mSync = Sync.NORMAL;
private int mCallTimeout = DEFAULT_CALL_TIMEOUT_DELAY_SECONDS; private int mCallTimeoutSeconds = DEFAULT_CALL_TIMEOUT_DELAY_SECONDS;
private int mTrafficChannelPoolSize = TRAFFIC_CHANNEL_LIMIT_DEFAULT; private int mTrafficChannelPoolSize = TRAFFIC_CHANNEL_LIMIT_DEFAULT;
public DecodeConfigMPT1327() public DecodeConfigMPT1327()
@@ -69,9 +69,9 @@ public class DecodeConfigMPT1327 extends DecodeConfiguration implements WithCall
} }
@JacksonXmlProperty(isAttribute = true, localName = "call_timeout") @JacksonXmlProperty(isAttribute = true, localName = "call_timeout")
public int getCallTimeout() public int getCallTimeoutSeconds()
{ {
return mCallTimeout; return mCallTimeoutSeconds;
} }
/** /**
@@ -79,15 +79,15 @@ public class DecodeConfigMPT1327 extends DecodeConfiguration implements WithCall
* *
* @param timeout * @param timeout
*/ */
public void setCallTimeout(int timeout) public void setCallTimeoutSeconds(int timeout)
{ {
if(CALL_TIMEOUT_MINIMUM <= timeout && timeout <= CALL_TIMEOUT_MAXIMUM) if(CALL_TIMEOUT_MINIMUM <= timeout && timeout <= CALL_TIMEOUT_MAXIMUM)
{ {
mCallTimeout = timeout; mCallTimeoutSeconds = timeout;
} }
else else
{ {
mCallTimeout = DEFAULT_CALL_TIMEOUT_DELAY_SECONDS; mCallTimeoutSeconds = DEFAULT_CALL_TIMEOUT_DELAY_SECONDS;
} }
} }

View File

@@ -42,7 +42,6 @@ import org.slf4j.LoggerFactory;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Collections; import java.util.Collections;
import java.util.HashMap; import java.util.HashMap;
import java.util.Iterator;
import java.util.List; import java.util.List;
import java.util.TreeSet; import java.util.TreeSet;
@@ -59,26 +58,30 @@ public class MPT1327DecoderState extends DecoderState
private ChannelType mChannelType; private ChannelType mChannelType;
private long mFrequency = 0; private long mFrequency = 0;
private long mCallTimeout; private long mCallTimeoutMilliseconds;
private MPT1327TrafficChannelManager mMPT1327TrafficChannelManager; private MPT1327TrafficChannelManager mMPT1327TrafficChannelManager;
/** /**
* Constructs an MPT-1327 decoder state with an optional traffic channel manager for allocating traffic channels * Constructs an MPT-1327 decoder state with an optional traffic channel manager for allocating traffic channels
* when go to channel (GTC) messages are detected. * when go to channel (GTC) messages are detected. This constructor assumes that channel type is STANDARD.
*
* @param trafficChannelManager for managing MPT1327 Traffic Channels
* @param callTimeoutMilliseconds for when traffic channels should automatically be stopped.
*/ */
public MPT1327DecoderState(MPT1327TrafficChannelManager trafficChannelManager, ChannelType channelType, long callTimeout) public MPT1327DecoderState(MPT1327TrafficChannelManager trafficChannelManager, ChannelType channelType,
long callTimeoutMilliseconds)
{ {
mMPT1327TrafficChannelManager = trafficChannelManager; mMPT1327TrafficChannelManager = trafficChannelManager;
mChannelType = channelType; mChannelType = channelType;
mCallTimeout = callTimeout; mCallTimeoutMilliseconds = callTimeoutMilliseconds;
} }
/** /**
* Constructs an MPT1327 decoder state that does not allocate traffic channels * Constructs an MPT1327 decoder state that does not allocate traffic channels
*/ */
public MPT1327DecoderState(ChannelType channelType, long callTimeout) public MPT1327DecoderState(ChannelType channelType, long callTimeoutMilliseconds)
{ {
this(null, channelType, callTimeout); this(null, channelType, callTimeoutMilliseconds);
} }
@Override @Override
@@ -250,7 +253,7 @@ public class MPT1327DecoderState extends DecoderState
{ {
//When we receive a MAINT message and we're configured as a standard channel, apply the call //When we receive a MAINT message and we're configured as a standard channel, apply the call
// timeout specified by the user. Otherwise we'll be using the shorter default call timeout // timeout specified by the user. Otherwise we'll be using the shorter default call timeout
broadcast(new ChangeChannelTimeoutEvent(this, mChannelType, mCallTimeout)); broadcast(new ChangeChannelTimeoutEvent(this, mChannelType, mCallTimeoutMilliseconds));
MutableIdentifierCollection ic = new MutableIdentifierCollection(getIdentifierCollection().getIdentifiers()); MutableIdentifierCollection ic = new MutableIdentifierCollection(getIdentifierCollection().getIdentifiers());
ic.remove(IdentifierClass.USER); ic.remove(IdentifierClass.USER);