#6 DMR Decoder (#947)

* #6 DMR decoder feature - work in progress

* #6 DMR Decoder.

* #6 DMR Decoder.  Code review updates.

Co-authored-by: Zhenyu Mao <maozhenyu@foxmail.com>
Co-authored-by: Denny <denny@denny-desktop>

src/main/java/io/github/dsheirer/channel/metadata/ChannelAndMetadata.java

@@ -0,0 +1,60 @@
+/*
+ * *****************************************************************************
+ *  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/>
+ * ****************************************************************************
+ */
+
+package io.github.dsheirer.channel.metadata;
+
+import io.github.dsheirer.controller.channel.Channel;
+
+import java.util.List;
+
+/**
+ * Channel and associated channel metadata
+ */
+public class ChannelAndMetadata
+{
+    private Channel mChannel;
+    private List<ChannelMetadata> mChannelMetadata;
+
+    /**
+     * Connstructs an instance
+     * @param channel
+     * @param metadata
+     */
+    public ChannelAndMetadata(Channel channel, List<ChannelMetadata> metadata)
+    {
+        mChannel = channel;
+        mChannelMetadata = metadata;
+    }
+
+    /**
+     * Channel
+     */
+    public Channel getChannel()
+    {
+        return mChannel;
+    }
+
+    /**
+     * Channel Metadata
+     */
+    public List<ChannelMetadata> getChannelMetadata()
+    {
+        return mChannelMetadata;
+    }
+}

src/main/java/io/github/dsheirer/channel/metadata/ChannelMetadataModel.java

@@ -28,6 +28,7 @@ import io.github.dsheirer.eventbus.MyEventBus;
 import io.github.dsheirer.identifier.Identifier;
 import io.github.dsheirer.identifier.decoder.DecoderLogicalChannelNameIdentifier;
 import io.github.dsheirer.preference.PreferenceType;
+import io.github.dsheirer.sample.Listener;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -57,10 +58,11 @@ public class ChannelMetadataModel extends AbstractTableModel implements IChannel
 
     private List<ChannelMetadata> mChannelMetadata = new ArrayList();
     private Map<ChannelMetadata,Channel> mMetadataChannelMap = new HashMap();
+    private Listener<ChannelAndMetadata> mChannelAddListener;
 
     public ChannelMetadataModel()
     {
-        MyEventBus.getEventBus().register(this);
+        MyEventBus.getGlobalEventBus().register(this);
     }
 
     /**
@@ -82,21 +84,66 @@ public class ChannelMetadataModel extends AbstractTableModel implements IChannel
         }
     }
 
-    public void add(Collection<ChannelMetadata> channelMetadatas, Channel channel)
+    public void dispose()
+    {
+        MyEventBus.getGlobalEventBus().unregister(this);
+    }
+
+    /**
+     * Lookup model row for the specified channel metadata
+     */
+    public int getRow(ChannelMetadata channelMetadata)
+    {
+        if(mChannelMetadata.contains(channelMetadata))
+        {
+            return mChannelMetadata.indexOf(channelMetadata);
+        }
+
+        return -1;
+    }
+
+    /**
+     * Registers the listener to be notified when channel metadata(s) are added to the model.
+     * @param listener to receive channel associated with the channel metadata(s) that were added
+     */
+    public void setChannelAddListener(Listener<ChannelAndMetadata> listener)
+    {
+        mChannelAddListener = listener;
+    }
+
+    public void add(ChannelAndMetadata channelAndMetadata)
     {
         //Execute on the swing thread to avoid threading issues
         EventQueue.invokeLater(() -> {
-            for(ChannelMetadata channelMetadata: channelMetadatas)
+            for(ChannelMetadata channelMetadata: channelAndMetadata.getChannelMetadata())
             {
                 mChannelMetadata.add(channelMetadata);
-                mMetadataChannelMap.put(channelMetadata, channel);
+                mMetadataChannelMap.put(channelMetadata, channelAndMetadata.getChannel());
                 int index = mChannelMetadata.indexOf(channelMetadata);
                 fireTableRowsInserted(index, index);
                 channelMetadata.setUpdateEventListener(ChannelMetadataModel.this);
             }
+
+            if(mChannelAddListener != null)
+            {
+                mChannelAddListener.receive(channelAndMetadata);
+            }
         });
     }
 
+    /**
+     * Updates the mapping of channel metadata to the channel used to create the channel metadatas (and processing chain)
+     * @param channelMetadatas
+     * @param channel
+     */
+    public void updateChannelMetadataToChannelMap(Collection<ChannelMetadata> channelMetadatas, Channel channel)
+    {
+        for(ChannelMetadata channelMetadata: channelMetadatas)
+        {
+            mMetadataChannelMap.put(channelMetadata, channel);
+        }
+    }
+
     public void remove(ChannelMetadata channelMetadata)
     {
         //Execute on the swing thread to avoid threading issues

src/main/java/io/github/dsheirer/channel/metadata/ChannelMetadataPanel.java

@@ -38,6 +38,8 @@ import io.github.dsheirer.preference.swing.JTableColumnWidthMonitor;
 import io.github.dsheirer.sample.Broadcaster;
 import io.github.dsheirer.sample.Listener;
 import net.miginfocom.swing.MigLayout;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
 
 import javax.swing.JLabel;
 import javax.swing.JMenuItem;
@@ -60,6 +62,8 @@ import java.util.Map;
 
 public class ChannelMetadataPanel extends JPanel implements ListSelectionListener
 {
+    private final static Logger mLog = LoggerFactory.getLogger(ChannelMetadataPanel.class);
+
     private static final String TABLE_PREFERENCE_KEY = "channel.metadata.panel";
     private ChannelModel mChannelModel;
     private ChannelProcessingManager mChannelProcessingManager;
@@ -70,6 +74,7 @@ public class ChannelMetadataPanel extends JPanel implements ListSelectionListene
     private Map<State,Color> mBackgroundColors = new EnumMap<>(State.class);
     private Map<State,Color> mForegroundColors = new EnumMap<>(State.class);
     private JTableColumnWidthMonitor mTableColumnMonitor;
+    private Channel mUserSelectedChannel;
 
     /**
      * Table view for currently decoding channel metadata
@@ -91,6 +96,7 @@ public class ChannelMetadataPanel extends JPanel implements ListSelectionListene
         setLayout( new MigLayout( "insets 0 0 0 0", "[grow,fill]", "[grow,fill]") );
 
         mTable = new JTable(mChannelProcessingManager.getChannelMetadataModel());
+        mChannelProcessingManager.getChannelMetadataModel().setChannelAddListener(new ChannelAddListener());
 
         DefaultTableCellRenderer renderer = (DefaultTableCellRenderer)mTable.getDefaultRenderer(String.class);
         renderer.setHorizontalAlignment(SwingConstants.CENTER);
@@ -165,9 +171,10 @@ public class ChannelMetadataPanel extends JPanel implements ListSelectionListene
 
                 if(selectedMetadata != null)
                 {
-                    Channel selectedChannel = mChannelProcessingManager.getChannelMetadataModel()
+                    mUserSelectedChannel = mChannelProcessingManager.getChannelMetadataModel()
                         .getChannelFromMetadata(selectedMetadata);
-                    processingChain = mChannelProcessingManager.getProcessingChain(selectedChannel);
+
+                    processingChain = mChannelProcessingManager.getProcessingChain(mUserSelectedChannel);
                 }
             }
 
@@ -422,4 +429,39 @@ public class ChannelMetadataPanel extends JPanel implements ListSelectionListene
             }
         }
     }
+
+    /**
+     * Listener to be notified when a channel and associated channel metadata(s) are added to the underlying
+     * channel metadata model.
+     *
+     * When a channel is added, it is compared the the last user selected channel and if they are the same, it
+     * invokes a selection event on the channel metadata row so that the channel metadata is re-selected.  This is
+     * primarily a hack to counter-act the DMR Capacity+ REST channel rotation where a channel is converted to a
+     * traffic channel and the previous channel is restarted.  The UI effect is that the user selected channel row
+     * in the Now Playing window continually loses selection over the channel and causes the user to perpetually
+     * chase the channel row.
+     */
+    public class ChannelAddListener implements Listener<ChannelAndMetadata>
+    {
+        @Override
+        public void receive(ChannelAndMetadata channelAndMetadata)
+        {
+            if(mUserSelectedChannel != null &&
+               mUserSelectedChannel.getChannelID() == channelAndMetadata.getChannel().getChannelID())
+            {
+                List<ChannelMetadata> metadata = channelAndMetadata.getChannelMetadata();
+
+                if(metadata.size() > 0)
+                {
+                    int modelRow = mChannelProcessingManager.getChannelMetadataModel().getRow(metadata.get(0));
+
+                    if(modelRow >= 0)
+                    {
+                        int tableRow = mTable.convertRowIndexToView(modelRow);
+                        mTable.getSelectionModel().setSelectionInterval(tableRow, tableRow);
+                    }
+                }
+            }
+        }
+    }
 }