Merge branch 'master' into 39-polyphase-channelizer

# Conflicts:
#	src/source/tuner/TunerController.java
This commit is contained in:
Denny
2017-10-22 06:28:57 -04:00
2 changed files with 293 additions and 316 deletions

View File

@@ -7,7 +7,7 @@
<property name="major" value="0"/> <property name="major" value="0"/>
<property name="minor" value="3"/> <property name="minor" value="3"/>
<property name="patch" value="1"/> <property name="patch" value="1"/>
<property name="release" value="final"/> <property name="release" value=""/> <!-- Use dash (-) prefix (e.g. -beta1) -->
<property name="filename" value="sdrtrunk_${major}.${minor}.${patch}${release}"/> <property name="filename" value="sdrtrunk_${major}.${minor}.${patch}${release}"/>
<!-- Build properties --> <!-- Build properties -->
@@ -34,7 +34,7 @@
<mkdir dir="${output.classes}"/> <mkdir dir="${output.classes}"/>
<!-- Create version file --> <!-- Create version file -->
<echo message="${major}.${minor}.${patch}-${release}" file="${output.classes}/sdrtrunk-version"/> <echo message="${major}.${minor}.${patch}${release}" file="${output.classes}/sdrtrunk-version"/>
</target> </target>
<target name="compile" depends="clean,init,compile-java-8,compile-java-9" <target name="compile" depends="clean,init,compile-java-8,compile-java-9"

View File

@@ -1,29 +1,24 @@
/******************************************************************************* /*******************************************************************************
* SDR Trunk * SDR Trunk
* Copyright (C) 2014-2016 Dennis Sheirer * Copyright (C) 2014-2017 Dennis Sheirer
* *
* This program is free software: you can redistribute it and/or modify * 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 * it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or * the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version. * (at your option) any later version.
* *
* This program is distributed in the hope that it will be useful, * This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of * but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details. * GNU General Public License for more details.
* *
* You should have received a copy of the GNU General Public License * You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/> * along with this program. If not, see <http://www.gnu.org/licenses/>
******************************************************************************/ ******************************************************************************/
package source.tuner; package source.tuner;
import java.util.SortedSet;
import java.util.concurrent.ConcurrentSkipListSet;
import java.util.concurrent.RejectedExecutionException;
import org.slf4j.Logger; import org.slf4j.Logger;
import org.slf4j.LoggerFactory; import org.slf4j.LoggerFactory;
import source.SourceException; import source.SourceException;
import source.tuner.configuration.TunerConfiguration; import source.tuner.configuration.TunerConfiguration;
import source.SourceEvent; import source.SourceEvent;
@@ -33,51 +28,46 @@ import source.tuner.frequency.FrequencyController.Tunable;
import source.ISourceEventProcessor; import source.ISourceEventProcessor;
public abstract class TunerController implements Tunable, ISourceEventProcessor public abstract class TunerController implements Tunable, ISourceEventProcessor
import java.util.SortedSet;
import java.util.concurrent.ConcurrentSkipListSet;
import java.util.concurrent.RejectedExecutionException;
public abstract class TunerController implements Tunable, IFrequencyChangeProcessor
{ {
private final static Logger mLog = private final static Logger mLog = LoggerFactory.getLogger(TunerController.class);
LoggerFactory.getLogger( TunerController.class );
/* List of currently tuned channels being served to demod channels */ /* List of currently tuned channels being served to demod channels */
private SortedSet<TunerChannel> mTunedChannels = new ConcurrentSkipListSet<>(); private SortedSet<TunerChannel> mTunedChannels = new ConcurrentSkipListSet<>();
protected FrequencyController mFrequencyController; protected FrequencyController mFrequencyController;
private int mMiddleUnusable; private int mMiddleUnusable;
private double mUsableBandwidthPercentage; private double mUsableBandwidthPercentage;
/**
* Abstract tuner controller class. The tuner controller manages frequency
* bandwidth and currently tuned channels that are being fed samples from
* the tuner.
*
* @param minimumFrequency minimum uncorrected tunable frequency
* @param maximumFrequency maximum uncorrected tunable frequency
* @param middleUnusable is the +/- value center DC spike to avoid for channels
* @param usableBandwidthPercentage is the unusable space at the extreme ends of the spectrum
*
* @throws SourceException - for any issues related to constructing the
* class, tuning a frequency, or setting the bandwidth
*/
public TunerController( long minimumFrequency,
long maximumFrequency,
int middleUnusable,
double usableBandwidthPercentage )
{
mFrequencyController = new FrequencyController( this,
minimumFrequency,
maximumFrequency,
0.0d );
mMiddleUnusable = middleUnusable;
mUsableBandwidthPercentage = usableBandwidthPercentage;
}
/**
* Applies the settings in the tuner configuration
*/
public abstract void apply( TunerConfiguration config )
throws SourceException;
/** /**
* Responds to requests to set the frequency * Abstract tuner controller class. The tuner controller manages frequency bandwidth and currently tuned channels
*/ * that are being fed samples from the tuner.
*
* @param minimumFrequency minimum uncorrected tunable frequency
* @param maximumFrequency maximum uncorrected tunable frequency
* @param middleUnusable is the +/- value center DC spike to avoid for channels
* @param usableBandwidth percentage of usable bandwidth relative to space at the extreme ends of the spectrum
* @throws SourceException - for any issues related to constructing the
* class, tuning a frequency, or setting the bandwidth
*/
public TunerController(long minimumFrequency, long maximumFrequency, int middleUnusable, double usableBandwidth)
{
mFrequencyController = new FrequencyController(this, minimumFrequency, maximumFrequency, 0.0d);
mMiddleUnusable = middleUnusable;
mUsableBandwidthPercentage = usableBandwidth;
}
/**
* Applies the settings in the tuner configuration
*/
public abstract void apply(TunerConfiguration config) throws SourceException;
/**
* Responds to requests to set the frequency
*/
@Override @Override
public void process(SourceEvent event ) throws SourceException public void process(SourceEvent event ) throws SourceException
{ {
@@ -87,292 +77,279 @@ public abstract class TunerController implements Tunable, ISourceEventProcessor
} }
} }
public int getBandwidth() public int getBandwidth()
{ {
return mFrequencyController.getBandwidth(); return mFrequencyController.getBandwidth();
} }
/** /**
* Sets the center frequency of the local oscillator. * Sets the center frequency of the local oscillator.
* *
* @param frequency in hertz * @param frequency in hertz
* @throws SourceException - if the tuner has any issues * @throws SourceException - if the tuner has any issues
*/ */
public void setFrequency( long frequency ) throws SourceException public void setFrequency(long frequency) throws SourceException
{ {
mFrequencyController.setFrequency( frequency ); mFrequencyController.setFrequency(frequency);
} }
/** /**
* Gets the center frequency of the local oscillator * Gets the center frequency of the local oscillator
* *
* @return frequency in hertz * @return frequency in hertz
*/ */
public long getFrequency() public long getFrequency()
{ {
return mFrequencyController.getFrequency(); return mFrequencyController.getFrequency();
} }
public int getSampleRate()
{
return mFrequencyController.getBandwidth();
}
public double getFrequencyCorrection() public int getSampleRate()
{ {
return mFrequencyController.getFrequencyCorrection(); return mFrequencyController.getBandwidth();
} }
public void setFrequencyCorrection( double correction ) throws SourceException
{
mFrequencyController.setFrequencyCorrection( correction );
}
public long getMinFrequency()
{
return mFrequencyController.getMinimumFrequency();
}
public long getMaxFrequency() public double getFrequencyCorrection()
{ {
return mFrequencyController.getMaximumFrequency(); return mFrequencyController.getFrequencyCorrection();
} }
private long getMinTunedFrequency() throws SourceException
{
return mFrequencyController.getFrequency() - ( getUsableBandwidth() / 2 );
}
private long getMaxTunedFrequency() throws SourceException public void setFrequencyCorrection(double correction) throws SourceException
{ {
return mFrequencyController.getFrequency() + ( getUsableBandwidth() / 2 ); mFrequencyController.setFrequencyCorrection(correction);
} }
/** public long getMinFrequency()
* Indicates if channel along with all of the other currently sourced {
* channels can fit within the tunable bandwidth. return mFrequencyController.getMinimumFrequency();
*/ }
private boolean canTune( TunerChannel channel )
{
//Make sure we're within the tunable frequency range of this tuner
if( getMinFrequency() < channel.getMinFrequency() &&
getMaxFrequency() > channel.getMaxFrequency() )
{
//If this is the first lock, then we're good
if( mTunedChannels.isEmpty() )
{
return true;
}
else
{
int usableBandwidth = getUsableBandwidth();
long minLockedFrequency = mTunedChannels.first().getMinFrequency();
long maxLockedFrequency = mTunedChannels.last().getMaxFrequency();
//Requested channel is within current locked channel frequency range public long getMaxFrequency()
if( minLockedFrequency <= channel.getMinFrequency() && {
channel.getMaxFrequency() <= maxLockedFrequency ) return mFrequencyController.getMaximumFrequency();
{ }
return true;
}
//Requested channel is higher than min locked frequency
if( channel.getMaxFrequency() > minLockedFrequency &&
channel.getMaxFrequency() - minLockedFrequency <= usableBandwidth )
{
return true;
}
//Requested channel is lower than the max locked frequency
if( channel.getMinFrequency() <= maxLockedFrequency &&
maxLockedFrequency - channel.getMinFrequency() <= usableBandwidth )
{
return true;
}
}
}
return false;
}
/** private long getMinTunedFrequency() throws SourceException
* Constructs a digital drop channel (DDC) as a tuner channel from from {
* the tuner, or returns null if the channel cannot be sourced from the return mFrequencyController.getFrequency() - (getUsableBandwidth() / 2);
* tuner. }
*
* This controller can't provide a channel if the channel, along with the
* current set of sourced channels, can't be accomodated within the current
* tuner bandwidth, or if a center frequency cannot be calculated that will
* ensure all of the channels can be accomodated and any defined central DC
* spike avoided.
*
* @param tuner to source the channel from
* @param channel with defined center frequency and bandwidth
*
* @return fully constructed tuner channel or null
*
* @throws RejectedExecutionException if the decimation processor has an error
*/
public TunerChannelSource getChannel( Tuner tuner, TunerChannel channel )
throws RejectedExecutionException
{
TunerChannelSource source = null;
if( canTune( channel ) )
{
try
{
mTunedChannels.add( channel );
if( requiresLOUpdate( channel ) ) private long getMaxTunedFrequency() throws SourceException
{ {
updateLOFrequency(); return mFrequencyController.getFrequency() + (getUsableBandwidth() / 2);
} }
source = new TunerChannelSource( tuner, channel );
}
catch( SourceException se )
{
mTunedChannels.remove( channel );
source = null;
}
}
return source; /**
} * Indicates if channel along with all of the other currently sourced
* channels can fit within the tunable bandwidth.
public int getChannelCount() */
{ private boolean canTune(TunerChannel channel)
return mTunedChannels.size(); {
} //Make sure we're within the tunable frequency range of this tuner
if(getMinFrequency() < channel.getMinFrequency() && getMaxFrequency() > channel.getMaxFrequency())
{
//If this is the first lock, then we're good
if(mTunedChannels.isEmpty())
{
return true;
}
else
{
int usableBandwidth = getUsableBandwidth();
long minLockedFrequency = mTunedChannels.first().getMinFrequency();
long maxLockedFrequency = mTunedChannels.last().getMaxFrequency();
/** //Requested channel is within current locked channel frequency range
* Indicates if the tuner's LO frequency must be updated in order to if(minLockedFrequency <= channel.getMinFrequency() && channel.getMaxFrequency() <= maxLockedFrequency)
* accomodate the tuner channel {
*/ return true;
private boolean requiresLOUpdate( TunerChannel channel ) throws SourceException }
{
return !( getMinTunedFrequency() <= channel.getMinFrequency() &&
channel.getMaxFrequency() <= getMaxTunedFrequency() &&
( ( mMiddleUnusable == 0 ) ||
( !channel.overlaps( getTunedFrequency() - mMiddleUnusable,
getTunedFrequency() + mMiddleUnusable ) ) ) );
}
/** //Requested channel is higher than min locked frequency
* Releases the currently sourced tuner channel from this tuner and shuts if(channel.getMaxFrequency() > minLockedFrequency &&
* down the tuner if no other sources exist. channel.getMaxFrequency() - minLockedFrequency <= usableBandwidth)
*/ {
public void releaseChannel( TunerChannelSource tunerChannelSource ) return true;
{ }
if( tunerChannelSource != null )
{
mTunedChannels.remove( tunerChannelSource.getTunerChannel() );
}
}
/**
* Sets the Local Oscillator frequency accomodate the current set of tuned
* channels.
*
* If there is only a single tuned channel, it is placed immediately to the
* right of the usable bandwidth right of the central DC spike.
*
* Otherwise, it places the highest channel frequency at the upper end of
* the tuner bandwidth, and then iteratively moves the center frequency
* higher until all channels fit within the bandwidth and none of the
* channels overlap any defined central DC spike unusable region. If a
* center tune frequency cannot be calculated, throw an exception so that
* the most recently added channel can be removed.
*
* Note: the tuned frequency is not changed until a legitimate new frequency
* can be calculated. If an exception is thrown, the current frequency is
* retained, so that the recently added channel can be removed and all other
* channels can continue as previously arranged.
*
* @throws SourceException if the set of tuner channels, including a recently
* added channel, cannot be tuned within the current tuner bandwidth and any
* central DC spike unusable region.
*/
private void updateLOFrequency() throws SourceException
{
long frequency = getFrequency();
boolean frequencyValid = true;
//If there is only 1 channel, position it to the right of center //Requested channel is lower than the max locked frequency
if( mTunedChannels.size() == 1 ) if(channel.getMinFrequency() <= maxLockedFrequency &&
{ maxLockedFrequency - channel.getMinFrequency() <= usableBandwidth)
frequency = mTunedChannels.first().getMinFrequency() - mMiddleUnusable; {
} return true;
else }
{ }
long minLockedFrequency = mTunedChannels.first().getMinFrequency(); }
long maxLockedFrequency = mTunedChannels.last().getMaxFrequency();
//Start by placing the highest frequency channel at the high end of return false;
//the spectrum }
frequency = maxLockedFrequency - ( getUsableBandwidth() / 2 );
//Iterate the channels and make sure that none of them overlap the /**
//center DC spike buffer, if one exists * Constructs a digital drop channel (DDC) as a tuner channel from from the tuner, or returns null if the channel
if( mMiddleUnusable > 0 ) * cannot be sourced from the tuner.
{ *
boolean processingRequired = true; * This controller can't provide a channel if the channel, along with the current set of sourced channels, can't be
* accomodated within the current tuner bandwidth, or if a center frequency cannot be calculated that will ensure
while( frequencyValid && processingRequired ) * all of the channels can be accomodated and any defined central DC spike avoided.
{ *
processingRequired = false; * @param tuner to source the channel from
* @param channel with defined center frequency and bandwidth
long minAvoid = frequency - mMiddleUnusable; * @return fully constructed tuner channel or null
long maxAvoid = frequency + mMiddleUnusable; * @throws RejectedExecutionException if the decimation processor has an error
*/
public TunerChannelSource getChannel(Tuner tuner, TunerChannel channel) throws RejectedExecutionException
{
TunerChannelSource source = null;
for( TunerChannel channel: mTunedChannels ) if(canTune(channel))
{ {
if( channel.overlaps( minAvoid, maxAvoid ) ) try
{ {
//Can we move the frequency lower so that the mTunedChannels.add(channel);
//channel sits to the right of center?
long adjustment = channel.getMaxFrequency() - minAvoid;
if( frequency + adjustment - if(requiresLOUpdate(channel))
( getUsableBandwidth() / 2 ) <= minLockedFrequency ) {
{ updateLOFrequency();
frequency += adjustment; }
processingRequired = true;
}
else
{
frequencyValid = false;
}
//break out of the for/each loop, so that we can
//start over again with all of the channels
break;
}
}
}
}
}
if( frequencyValid ) source = new TunerChannelSource(tuner, channel);
{ }
mFrequencyController.setFrequency( frequency ); catch(SourceException se)
} {
else mTunedChannels.remove(channel);
{ source = null;
throw new SourceException( "Couldn't calculate viable center " }
+ "frequency from set of tuner channels" ); }
}
}
/** return source;
* Usable bandwidth - total bandwidth minus the unusable space at either end }
* of the spectrum.
*/ public int getChannelCount()
private int getUsableBandwidth() {
{ return mTunedChannels.size();
return (int)( getBandwidth() * mUsableBandwidthPercentage ); }
}
/**
* Indicates if the tuner's LO frequency must be updated in order to accommodate the tuner channel
*/
private boolean requiresLOUpdate(TunerChannel channel) throws SourceException
{
boolean isBelow = channel.getMinFrequency() < getMinTunedFrequency();
boolean isAbove = channel.getMaxFrequency() > getMaxTunedFrequency();
boolean overlapsCenter = mMiddleUnusable > 0 &&
channel.overlaps(getFrequency() - mMiddleUnusable, getFrequency() + mMiddleUnusable);
return isAbove || isBelow || overlapsCenter;
}
/**
* Releases the currently sourced tuner channel from this tuner and shuts down the tuner if no other sources exist.
*/
public void releaseChannel(TunerChannelSource tunerChannelSource)
{
if(tunerChannelSource != null)
{
mTunedChannels.remove(tunerChannelSource.getTunerChannel());
}
}
/**
* Sets the Local Oscillator frequency to accomodate the current set of tuned channels.
*
* If there is only a single tuned channel, it is placed immediately to the right of the usable bandwidth right
* of the central DC spike.
*
* Otherwise, it places the highest channel frequency at the upper end of the tuner bandwidth, and then iteratively
* moves the center frequency higher until all channels fit within the bandwidth and none of the channels overlap
* any defined central DC spike unusable region. If a center tune frequency cannot be calculated, throw an
* exception so that the most recently added channel can be removed.
*
* Note: the tuned frequency is not changed until a legitimate new frequency can be calculated. If an exception
* is thrown, the current frequency is retained, so that the recently added channel can be removed and all other
* channels can continue as previously arranged.
*
* @throws SourceException if the set of tuner channels, including a recently added channel, cannot be tuned
* within the current tuner bandwidth and any central DC spike unusable region.
*/
private void updateLOFrequency() throws SourceException
{
long candidateFrequency;
boolean isValidCandidateFrequency = true;
//If there is only 1 channel set the center frequency so that the channel is positioned to the right of center
if(mTunedChannels.size() == 1)
{
candidateFrequency = mTunedChannels.first().getMinFrequency() - mMiddleUnusable + 1;
}
else
{
long minLockedFrequency = mTunedChannels.first().getMinFrequency();
long maxLockedFrequency = mTunedChannels.last().getMaxFrequency();
//Start by placing the highest frequency channel at the high end of the spectrum
candidateFrequency = maxLockedFrequency - (getUsableBandwidth() / 2);
//Iterate the channels and make sure that none of them overlap the center DC spike buffer, if one exists
if(mMiddleUnusable > 0)
{
boolean processingRequired = true;
while(isValidCandidateFrequency && processingRequired)
{
processingRequired = false;
long minAvoid = candidateFrequency - mMiddleUnusable;
long maxAvoid = candidateFrequency + mMiddleUnusable;
//If any of the center channel(s) overlap the central DC spike avoid area, we'll iteratively
//increase the tuned frequency causing the set of channels to move left in the tuned bandwidth until
//we either find a good center tune frequency, or we walk the lowest frequency channel out of the
//minimum tuned range, in which case we'll throw an exception indicating we don't have a solution.
for(TunerChannel channel : mTunedChannels)
{
if(channel.overlaps(minAvoid, maxAvoid))
{
//Calculate a tuned frequency adjustment that places this overlapping channel just to the
//left of the central DC spike avoid zone
long adjustment = channel.getMaxFrequency() - minAvoid + 1;
//If the candidate frequency doesn't push the lowest channel out of bounds, make adjustment
if(candidateFrequency + adjustment - (getUsableBandwidth() / 2) <= minLockedFrequency)
{
candidateFrequency += adjustment;
processingRequired = true;
}
//Otherwise, punt and indicate that we can't find a center frequency or add the channel
else
{
isValidCandidateFrequency = false;
}
//break out of the for/each loop, so that we can start over again with all of the channels
break;
}
}
}
}
}
if(isValidCandidateFrequency)
{
mFrequencyController.setFrequency(candidateFrequency);
}
else
{
throw new SourceException("Couldn't calculate viable center frequency from set of tuner channels");
}
}
/**
* Usable bandwidth - total bandwidth minus the unusable space at either end of the spectrum.
*/
private int getUsableBandwidth()
{
return (int)(getBandwidth() * mUsableBandwidthPercentage);
}
/** /**
* Sets the listener to be notified any time that the tuner changes frequency * Sets the listener to be notified any time that the tuner changes frequency
@@ -383,7 +360,7 @@ public abstract class TunerController implements Tunable, ISourceEventProcessor
*/ */
public void addListener( ISourceEventProcessor processor ) public void addListener( ISourceEventProcessor processor )
{ {
mFrequencyController.addListener( processor ); mFrequencyController.addListener(processor);
} }
/** /**
@@ -391,6 +368,6 @@ public abstract class TunerController implements Tunable, ISourceEventProcessor
*/ */
public void removeListener( ISourceEventProcessor processor ) public void removeListener( ISourceEventProcessor processor )
{ {
mFrequencyController.removeFrequencyChangeProcessor( processor ); mFrequencyController.removeFrequencyChangeProcessor(processor);
} }
} }