#1190 Tuner management redesign. Updates all tuners with direct threaded support. Incorporates USB Hotplug support. Adds black/white listing of tuners. Updates all tuner editors to have a common look and feel. Changes location of tuner configuration file and changes format to JSON. (#1208)

Co-authored-by: Dennis Sheirer <dsheirer@github.com>
2026-11-12 16:47:31 -05:00 · 2022-04-18 07:30:58 -04:00
parent 0fb148d31e
commit 96d3996bec
259 changed files with 11974 additions and 12454 deletions
--- a/src/main/java/io/github/dsheirer/source/tuner/Tuner.java
+++ b/src/main/java/io/github/dsheirer/source/tuner/Tuner.java
@@ -1,32 +1,29 @@
 /*
+ * *****************************************************************************
+ * Copyright (C) 2014-2022 Dennis Sheirer
 *
- *  * ******************************************************************************
- *  * Copyright (C) 2014-2020 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
- *  * the Free Software Foundation, either version 3 of the License, or
- *  * (at your option) any later version.
- *  *
- *  * This program is distributed in the hope that it will be useful,
- *  * but WITHOUT ANY WARRANTY; without even the implied warranty of
- *  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- *  * GNU General Public License for more details.
- *  *
- *  * You should have received a copy of the GNU General Public License
- *  * along with this program.  If not, see <http://www.gnu.org/licenses/>
- *  * *****************************************************************************
+ * 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
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
 *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
 *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>
+ * ****************************************************************************
 */
 package io.github.dsheirer.source.tuner;

-import io.github.dsheirer.preference.UserPreferences;
 import io.github.dsheirer.preference.source.ChannelizerType;
 import io.github.dsheirer.sample.Broadcaster;
 import io.github.dsheirer.sample.Listener;
 import io.github.dsheirer.source.ISourceEventProcessor;
 import io.github.dsheirer.source.SourceEvent;
+import io.github.dsheirer.source.SourceException;
 import io.github.dsheirer.source.tuner.TunerEvent.Event;
 import io.github.dsheirer.source.tuner.manager.ChannelSourceManager;
 import io.github.dsheirer.source.tuner.manager.HeterodyneChannelSourceManager;
@@ -46,31 +43,28 @@ public abstract class Tuner implements ISourceEventProcessor, ITunerErrorListene
    private ChannelSourceManager mChannelSourceManager;
    private TunerController mTunerController;
    private TunerFrequencyErrorMonitor mTunerFrequencyErrorMonitor;
-    private String mName;
-    private String mErrorMessage;
+    private ITunerErrorListener mTunerErrorListener;

-    public Tuner(String name, TunerController tunerController)
+    public Tuner(TunerController tunerController, ITunerErrorListener tunerErrorListener)
    {
-        mName = name;
        mTunerController = tunerController;
+        mTunerErrorListener = tunerErrorListener;
        //Register to receive frequency and sample rate change notifications
        mTunerController.addListener(this::process);
-        mTunerController.setTunerErrorListener(this);
        mTunerFrequencyErrorMonitor = new TunerFrequencyErrorMonitor(this);
        mTunerFrequencyErrorMonitor.start();
    }

    /**
     * Abstract tuner class.
-     * @param name of the tuner
     * @param tunerController for the tuner
-     * @param userPreferences to discover preferred channelizer type
+     * @param tunerErrorListener to listen for tuner errors
+     * @param channelizerType for the channelizer
     */
-    public Tuner(String name, TunerController tunerController, UserPreferences userPreferences)
+    public Tuner(TunerController tunerController, ITunerErrorListener tunerErrorListener, ChannelizerType channelizerType)
    {
-        this(name, tunerController);
+        this(tunerController, tunerErrorListener);

-        ChannelizerType channelizerType = userPreferences.getTunerPreference().getChannelizerType();
        if(channelizerType == ChannelizerType.POLYPHASE)
        {
            setChannelSourceManager(new PolyphaseChannelSourceManager(mTunerController));
@@ -85,6 +79,58 @@ public abstract class Tuner implements ISourceEventProcessor, ITunerErrorListene
        }
    }

+    /**
+     * Perform startup operations
+     * @throws SourceException if there is an error that makes this tuner unusable
+     */
+    public void start() throws SourceException
+    {
+        try
+        {
+            getTunerController().start();
+        }
+        catch(SourceException se)
+        {
+            //Rethrow the source exception
+            throw se;
+        }
+        catch(Exception e)
+        {
+            //Wrap any other exceptions in a new source exception
+            mLog.error("Error starting " + getTunerClass() + " tuner", e);
+            throw new SourceException("Unable to start " + getTunerClass() + " tuner", e);
+        }
+    }
+
+    /**
+     * Perform shutdown and disposal operations.
+     */
+    public void stop()
+    {
+        if(getChannelSourceManager() != null)
+        {
+            getChannelSourceManager().stopAllChannels();
+        }
+
+        broadcast(new TunerEvent(this, Event.NOTIFICATION_SHUTTING_DOWN));
+        getTunerController().stop();
+    }
+
+    /**
+     * Sets an unrecoverable error state for this tuner and propagates the error to an external listener
+     * @param errorMessage to set
+     */
+    @Override
+    public void setErrorMessage(String errorMessage)
+    {
+        broadcast(new TunerEvent(this, Event.NOTIFICATION_ERROR_STATE));
+
+        if(mTunerErrorListener != null)
+        {
+            mTunerErrorListener.setErrorMessage(errorMessage);
+        }
+    }
+
    /**
     * Sets the channel source manager
     * @param manager to use
@@ -97,60 +143,32 @@ public abstract class Tuner implements ISourceEventProcessor, ITunerErrorListene
        mChannelSourceManager.addSourceEventListener(this::process);
    }

-    /**
-     * Sets this tuner to an error state with the errorMessage description.
-     * @param errorMessage describing the error state
-     */
-    public void setErrorMessage(String errorMessage)
-    {
-        mLog.info("[" + getName() + "] tuner is now disabled for error [" + errorMessage + "]");
-        mErrorMessage = errorMessage;
-        broadcast(new TunerEvent(this, Event.ERROR_STATE));
-        getChannelSourceManager().setErrorMessage(errorMessage);
-    }
-
    /**
     * Maximum number of bytes per second (MBps) produced by this tuner.
     * @return Bytes Per Second (Bps)
     */
    public abstract int getMaximumUSBBitsPerSecond();

-    /**
-     * Optional error message that describes an error state.
-     */
-    public String getErrorMessage()
-    {
-        return mErrorMessage;
-    }
-
-    /**
-     * Indicates if this tuner has an error.
-     */
-    public boolean hasError()
-    {
-        return mErrorMessage != null;
-    }
-
    @Override
    public void process(SourceEvent event)
    {
        switch(event.getEvent())
        {
            case NOTIFICATION_CHANNEL_COUNT_CHANGE:
-                broadcast(new TunerEvent(Tuner.this, Event.CHANNEL_COUNT));
+                broadcast(new TunerEvent(Tuner.this, Event.UPDATE_CHANNEL_COUNT));
                break;
            case NOTIFICATION_FREQUENCY_CHANGE:
-                broadcast(new TunerEvent(Tuner.this, Event.FREQUENCY_UPDATED));
+                broadcast(new TunerEvent(Tuner.this, Event.UPDATE_FREQUENCY));
                break;
            case NOTIFICATION_FREQUENCY_CORRECTION_CHANGE:
-                broadcast(new TunerEvent(Tuner.this, Event.FREQUENCY_ERROR_UPDATED));
+                broadcast(new TunerEvent(Tuner.this, Event.UPDATE_FREQUENCY_ERROR));
                break;
            case NOTIFICATION_SAMPLE_RATE_CHANGE:
-                broadcast(new TunerEvent(Tuner.this, Event.SAMPLE_RATE_UPDATED));
+                broadcast(new TunerEvent(Tuner.this, Event.UPDATE_SAMPLE_RATE));
                break;
            case NOTIFICATION_FREQUENCY_AND_SAMPLE_RATE_LOCKED:
            case NOTIFICATION_FREQUENCY_AND_SAMPLE_RATE_UNLOCKED:
-                broadcast(new TunerEvent(Tuner.this, Event.LOCK_STATE_CHANGE));
+                broadcast(new TunerEvent(Tuner.this, Event.UPDATE_LOCK_STATE));
                break;
            case NOTIFICATION_MEASURED_FREQUENCY_ERROR_SYNC_LOCKED:
                mTunerFrequencyErrorMonitor.receive(event);
@@ -159,7 +177,7 @@ public abstract class Tuner implements ISourceEventProcessor, ITunerErrorListene
                //ignore
                break;
            default:
-                mLog.debug("Unrecognized Source Event: " + event.toString());
+                mLog.debug("Unrecognized Source Event: " + event);
                break;
        }
    }
@@ -185,23 +203,7 @@ public abstract class Tuner implements ISourceEventProcessor, ITunerErrorListene
     */
    public String toString()
    {
-        return mName + (hasError() ? mErrorMessage : "");
-    }
-
-    /**
-     * Dispose and prepare for shutdown
-     */
-    public void dispose()
-    {
-        getTunerController().dispose();
-    }
-
-    /**
-     * Sets the name for this tuner
-     */
-    public void setName(String name)
-    {
-        mName = name;
+        return getPreferredName();
    }

    /**
@@ -220,17 +222,17 @@ public abstract class Tuner implements ISourceEventProcessor, ITunerErrorListene
    /**
     * @return - tuner type enum entry
     */
-    public abstract TunerType getTunerType();
+    public TunerType getTunerType()
+    {
+        return getTunerController().getTunerType();
+    }

    /**
-     * Name of this tuner object
+     * Preferred name for this.  This should be unique and will be used to find this tuner (e.g. channel preferred tuner)
     *
     * @return - string name of this tuner object
     */
-    public String getName()
-    {
-        return mName;
-    }
+    public abstract String getPreferredName();

    /**
     * Sample size in bits
@@ -240,7 +242,7 @@ public abstract class Tuner implements ISourceEventProcessor, ITunerErrorListene
    /**
     * Registers the listener
     */
-    public void addTunerChangeListener(Listener<TunerEvent> listener)
+    public void addTunerEventListener(Listener<TunerEvent> listener)
    {
        mTunerEventBroadcaster.addListener(listener);
    }
@@ -248,7 +250,7 @@ public abstract class Tuner implements ISourceEventProcessor, ITunerErrorListene
    /**
     * Removes the registered listener
     */
-    public void removeTunerChangeListener(Listener<TunerEvent> listener)
+    public void removeTunerEventListener(Listener<TunerEvent> listener)
    {
        mTunerEventBroadcaster.removeListener(listener);
    }