Add a Codacy badge to README.md

.github/ISSUE_TEMPLATE/bug_report.md

@@ -28,5 +28,8 @@ If applicable, add screenshots to help explain your problem.
  - Plugin Version [e.g. 1.2]
  - SDR# Version [e.g. revision 1770 4698f0a]
 
+**Plugin Log**
+A copy of \RPCLogs\DiscordRPCLog_XX.XX.XXXX.log on https://pastebin.com or other copy-paste website.
+
 **Additional context**
 Add any other context about the problem here.

.github/MEDIA/README.md

@@ -0,0 +1 @@
+# Files for README.md

LICENSE

@@ -632,7 +632,7 @@ state the exclusion of warranty; and each file should have at least
 the "copyright" line and a pointer to where the full notice is found.
 
     SDR-RPC | Plugin for SDRSharp Software adding Discord Rich Presence
-    Copyright (C) 2020  Albu Alexandru Gabriel
+    Copyright (C) 2021  Albu Alexandru Gabriel
 
     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
@@ -652,7 +652,7 @@ Also add information on how to contact you by electronic and paper mail.
   If the program does terminal interaction, make it output a short
 notice like this when it starts in an interactive mode:
 
-    SDR-RPC  Copyright (C) 2020  Albu Alexandru Gabriel
+    SDR-RPC  Copyright (C) 2021  Albu Alexandru Gabriel
     This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
     This is free software, and you are welcome to redistribute it
     under certain conditions; type `show c' for details.

LogWriter.cs

@@ -8,7 +8,10 @@ namespace EnderIce2.SDRSharpPlugin
         public static void WriteToFile(string Message)
         {
             if (!SDRSharp.Radio.Utils.GetBooleanSetting("LogRPC", false))
+            {
                 return;
+            }
+
             string path = AppDomain.CurrentDomain.BaseDirectory + "\\RPCLogs\\";
             if (!Directory.Exists(path))
             {

MainPlugin.cs

@@ -14,17 +14,14 @@ namespace EnderIce2.SDRSharpPlugin
     {
         private const string _displayName = "Discord RPC";
         private SettingsPanel _controlPanel;
-        [System.Diagnostics.CodeAnalysis.SuppressMessage("Style", "IDE0044:Add readonly modifier", Justification = "<Pending>")]
+        private const LogLevel logLevel = LogLevel.Trace;
-        private static LogLevel logLevel = LogLevel.Trace;
+        private const int discordPipe = -1;
-        [System.Diagnostics.CodeAnalysis.SuppressMessage("Style", "IDE0044:Add readonly modifier", Justification = "<Pending>")]
-        private static int discordPipe = -1;
         [System.Diagnostics.CodeAnalysis.SuppressMessage("Style", "IDE0044:Add readonly modifier", Justification = "<Pending>")]
         bool RPCalreadyLoaded = false;
         private ISharpControl _control;
         bool playedBefore = false;
-        private IConfigurationPanelProvider configurationPanelProvider;
         private SDRSharp.FrontEnds.SpyServer.ControllerPanel controllerPanel;
-        public TopWindowMessages windowMessages;
+        private TopWindowMessages windowMessages;
         [System.Diagnostics.CodeAnalysis.SuppressMessage("Style", "IDE0044:Add readonly modifier", Justification = "<Pending>")]
         private RichPresence presence = new RichPresence()
         {
@@ -35,39 +32,38 @@ namespace EnderIce2.SDRSharpPlugin
                 LargeImageKey = "image_large",
                 LargeImageText = "SDRSharp",
                 SmallImageKey = "image_small",
-                SmallImageText = $"SDR-RPC plugin v{Assembly.GetEntryAssembly().GetName().Version} by EnderIce2"
+                SmallImageText = $"SDR-RPC plugin v{Assembly.LoadFrom("SDR-RPC.dll").GetName().Version} by EnderIce2" // should show the correct version
             }
         };
-        private static DiscordRpcClient client;
+        private DiscordRpcClient client;
-        private static bool isRunning = true;
+        private bool isRunning = true;
-        public string DisplayName
+        public string DisplayName => _displayName;
-        {
+        public bool HasGui => true;
-            get { return _displayName; }
+        public UserControl Gui => _controlPanel;
-        }
-        public bool HasGui
-        {
-            get { return true; }
-        }
-        public UserControl Gui
-        {
-            get { return _controlPanel; }
-        }
         public void Initialize(ISharpControl control)
         {
+            IConfigurationPanelProvider configurationPanelProvider;
+
             if (Utils.GetBooleanSetting("ShowWelcomePage", true))
+            {
                 new WelcomeForm().ShowDialog();
+            }
+
             _controlPanel = new SettingsPanel();
             windowMessages = new TopWindowMessages(); // TODO: do something when "EnableRPCInvite" is set to false
             _control = control;
             try
             {
                 if (Utils.GetBooleanSetting("EnableRPCInvite", false))
+                {
                     _control.RegisterFrontControl(windowMessages, PluginPosition.Top);
                 }
+            }
             catch (Exception ex)
             {
                 MessageBox.Show(ex.ToString());
             }
+
             if (Utils.GetBooleanSetting("EnableRPCInvite", false))
             {
                 presence.Secrets = new Secrets()
@@ -81,8 +77,12 @@ namespace EnderIce2.SDRSharpPlugin
                     Max = 100
                 };
             }
+
             if (Utils.GetBooleanSetting("EnableRPCInvite", false))
+            {
                 windowMessages.Show();
+            }
+
             if (Utils.GetBooleanSetting("EnableRPC", true))
             {
                 if (RPCalreadyLoaded)
@@ -91,15 +91,20 @@ namespace EnderIce2.SDRSharpPlugin
                     return;
                 }
                 if (Utils.GetStringSetting("ClientID").Replace(" ", "").Length != 18)
+                {
                     client = new DiscordRpcClient("765213507321856078", pipe: discordPipe)
                     {
                         Logger = new ConsoleLogger(logLevel, true)
                     };
+                }
                 else
+                {
                     client = new DiscordRpcClient(Utils.GetStringSetting("ClientID"), pipe: discordPipe)
                     {
                         Logger = new ConsoleLogger(logLevel, true)
                     };
+                }
+
                 client.RegisterUriScheme();
                 client.OnRpcMessage += Client_OnRpcMessage;
                 client.OnPresenceUpdate += Client_OnPresenceUpdate;
@@ -112,13 +117,16 @@ namespace EnderIce2.SDRSharpPlugin
                 client.OnUnsubscribe += OnUnsubscribe;
                 client.OnJoin += OnJoin;
                 client.OnJoinRequested += OnJoinRequested;
-                //client.OnSpectate += OnSpectate;
                 presence.Timestamps = new Timestamps()
                 {
                     Start = DateTime.UtcNow
                 };
+
                 if (Utils.GetBooleanSetting("EnableRPCInvite", false))
+                {
                     client.SetSubscription(EventType.Join | EventType.JoinRequest);
+                }
+
                 client.SetPresence(presence);
                 client.Initialize();
                 try
@@ -128,13 +136,15 @@ namespace EnderIce2.SDRSharpPlugin
                 }
                 catch (Exception ex)
                 {
-                    LogWriter.WriteToFile("----> " + ex.ToString());
+                    LogWriter.WriteToFile("----> " + ex);
                     MessageBox.Show($"Cannot get Spy Server Network address\n\nError:\n{ex}", "Warning", MessageBoxButtons.OK, MessageBoxIcon.Warning);
                 }
                 _ = MainLoop();
             }
             else
+            {
                 _controlPanel.ChangeStatus = "RPC is disabled";
+            }
             LogWriter.WriteToFile("EOM Initialize");
         }
         private void Client_OnPresenceUpdate(object sender, PresenceMessage args)
@@ -209,7 +219,7 @@ namespace EnderIce2.SDRSharpPlugin
         {
             try
             {
-                await Task.Delay(2000);
+                await Task.Delay(2000).ConfigureAwait(false);
                 isRunning = true;
                 LogWriter.WriteToFile($"MainLoop called {isRunning} {client.IsInitialized}");
                 while (client != null && isRunning)
@@ -229,7 +239,7 @@ namespace EnderIce2.SDRSharpPlugin
                         }
                     }
                     LogWriter.WriteToFile("Waiting 500ms in loop...");
-                    await Task.Delay(500);
+                    await Task.Delay(500).ConfigureAwait(false);
                     if (_control.RdsRadioText != null)
                     {
                         if (_control.IsPlaying)
@@ -238,7 +248,10 @@ namespace EnderIce2.SDRSharpPlugin
                             playedBefore = true;
                         }
                         else if (!_control.IsPlaying && playedBefore)
+                        {
                             presence.Assets.SmallImageKey = "pause";
+                        }
+
                         if (!playedBefore)
                         {
                             presence.Details = "Frequency: Not playing";
@@ -257,16 +270,20 @@ namespace EnderIce2.SDRSharpPlugin
                                 LogWriter.WriteToFile("Setting presence...");
                                 presence.Details = $"Frequency: {string.Format("{0:#,0,,0 Hz}", _control.Frequency)}";
                                 if (string.IsNullOrWhiteSpace(_control.RdsRadioText + _control.RdsProgramService))
+                                {
                                     presence.State = $"RDS: unknown{space_for_listen_list}";
+                                }
                                 else
+                                {
                                     presence.State = $"RDS: {_control.RdsProgramService} - {_control.RdsRadioText}{space_for_listen_list}";
                                 }
+                            }
                             catch (Exception ex)
                             {
                                 LogWriter.WriteToFile(ex.ToString());
                             }
-                            /*presence.Secrets.JoinSecret = */
+                            /* presence.Secrets.JoinSecret = */
-                            //_control.RegisterFrontControl(Gui, PluginPosition.Top);
+                            /* _control.RegisterFrontControl(Gui, PluginPosition.Top); */
                         }
                         try
                         {
@@ -282,14 +299,18 @@ namespace EnderIce2.SDRSharpPlugin
                     else
                     {
                         LogWriter.WriteToFile("Frequency or Radio Text are null!");
-                        await Task.Delay(1000);
+                        await Task.Delay(1000).ConfigureAwait(false);
                     }
                 }
                 if (client == null)
+                {
                     _controlPanel.ChangeStatus = "Client was null";
+                }
                 else
+                {
                     _controlPanel.ChangeStatus = "Presence stopped";
                 }
+            }
             catch (Exception ex)
             {
                 if (ex.Message.Contains("The process cannot access the file"))

Properties/AssemblyInfo.cs

@@ -32,5 +32,5 @@ using System.Runtime.InteropServices;
 // You can specify all the values or you can default the Build and Revision Numbers
 // by using the '*' as shown below:
 // [assembly: AssemblyVersion("1.0.*")]
-[assembly: AssemblyVersion("0.1.0.0")]
+[assembly: AssemblyVersion("1.0.0.0")]
-[assembly: AssemblyFileVersion("0.1.0.0")]
+[assembly: AssemblyFileVersion("1.0.0.0")]

README.md

@@ -1 +1,86 @@
+![GitHub](https://img.shields.io/github/license/EnderIce2/SDR-RPC)
+![GitHub All Releases](https://img.shields.io/github/downloads/EnderIce2/SDR-RPC/total)
+![GitHub release (latest by date)](https://img.shields.io/github/v/release/EnderIce2/SDR-RPC)
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/800cd7ade7ab4aa386f79b5c999a2959)](https://app.codacy.com/gh/EnderIce2/SDR-RPC?utm_source=github.com&utm_medium=referral&utm_content=EnderIce2/SDR-RPC&utm_campaign=Badge_Grade_Settings)
+[![CodeFactor](https://www.codefactor.io/repository/github/enderice2/sdr-rpc/badge?s=6ea1f91b515716a019633ad07f7d3138bc136f22)](https://www.codefactor.io/repository/github/enderice2/sdr-rpc)
+![Twitter Follow](https://img.shields.io/twitter/follow/enderice22?style=social)
 # SDR-RPC
+
+SDR-RPC is an [SDRSharp](https://airspy.com/download/) plugin that adds Discord RPC feature in it
+
+---
+
+### ✨Features
+- 🎛Enable / Disable
+- ✏Showing frequency, play state and RDS almost in realtime
+- 🔌Most of the code is made asynchronous
+- 📖Logging for troubleshooting problems
+- 🔨Easy to install
+- 🎧Invite feature (give Spy Server Address or listen using voice chat system) [coming soon]
+
+---
+
+### 🎁How to install
+
+📽Video:
+
+[![](http://img.youtube.com/vi/Otn-xSn_ioI/0.jpg)](http://www.youtube.com/watch?v=Otn-xSn_ioI "")
+
+---
+
+### 🎫Example
+
+📽Video:
+
+[![](http://img.youtube.com/vi/7k02dPqAjBA/0.jpg)](http://www.youtube.com/watch?v=7k02dPqAjBA "")
+
+---
+
+### 💻Building by yourself
+
+1. You need to download this stuff before compiling:
+- [Visual Studio 2019](https://visualstudio.microsoft.com/vs/)
+  - [.NET 4.6](https://dotnet.microsoft.com/download/dotnet-framework/thank-you/net46-developer-pack-offline-installer)
+  - SDRSharp files (for References)
+    - SDRSharp.exe
+    - SDRSharp.Common.dll
+    - SDRSharp.PanView.dll
+    - SDRSharp.Radio.dll
+
+2. Click "Code" and select "Open with Visual Studio" or "Download ZIP"
+
+![Captură de ecran 2020-10-26 025111.png](https://raw.githubusercontent.com/EnderIce2/SDR-RPC/master/.github/MEDIA/Captur%C4%83%20de%20ecran%202020-10-26%20025111.png)
+
+3. If you downloaded as ZIP, unzip the archive and double click on "SDRSharpPlugin.DiscordRPC.sln"
+4. Build it and move files to SDR# location (if the compile fails try copying Reference files into /bin/Debug or /bin/Release folder)
+
+---
+
+### 👀Setting your custom images on RPC
+
+1. Go to https://discord.com/developers/applications and create your own application
+2. Name it "SDRSharp" or something similar
+
+![Captură de ecran 2020-10-26 023639.png](https://raw.githubusercontent.com/EnderIce2/SDR-RPC/master/.github/MEDIA/Captur%C4%83%20de%20ecran%202020-10-26%20023639.png)
+
+3. Go to Rich Presence > Rich Presence Assets and add your own images with these names:
+
+![Captură de ecran 2020-10-26 023706.png](https://raw.githubusercontent.com/EnderIce2/SDR-RPC/master/.github/MEDIA/Captur%C4%83%20de%20ecran%202020-10-26%20023706.png)
+
+4. Go back to General Information and copy Client ID
+
+![Captură de ecran 2020-10-26 023915.png](https://raw.githubusercontent.com/EnderIce2/SDR-RPC/master/.github/MEDIA/Captur%C4%83%20de%20ecran%202020-10-26%20023915.png)
+
+5. Paste the Client ID you copied earlier in plugin textbox from SDRSharp and press the ENTER key
+
+![Captură de ecran 2020-10-26 024024.png](https://raw.githubusercontent.com/EnderIce2/SDR-RPC/master/.github/MEDIA/Captur%C4%83%20de%20ecran%202020-10-26%20024024.png)
+
+6. Restart the SDRSharp and it should be changed with your custom images
+
+---
+
+### 📕TODO List
+
+- Invite people to get Spy Server Address or connecting via voice chat system to listen and having the ability to change the frequency
+- Change Settings Panel to WPF User Control
+- Add better RDS decoder (if it is even possible)

SDRSharpPlugin.DiscordRPC.csproj

@@ -165,7 +165,7 @@
   </ItemGroup>
   <ItemGroup>
     <Content Include="DiscordAPI\LICENSE.txt" />
-    <Content Include="Resgister.txt">
+    <Content Include="Register.txt">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </Content>
   </ItemGroup>

SettingsPanel.cs

@@ -26,17 +26,31 @@ namespace EnderIce2.SDRSharpPlugin
             InitializeComponent();
             textBox1.Text = Utils.GetStringSetting("ClientID");
             if (Utils.GetBooleanSetting("EnableRPC", true))
+            {
                 checkBox1.Checked = true;
+            }
             else
+            {
                 checkBox1.Checked = false;
+            }
+
             if (Utils.GetBooleanSetting("LogRPC", false))
+            {
                 checkBox2.Checked = true;
+            }
             else
+            {
                 checkBox2.Checked = false;
+            }
+
             if (Utils.GetBooleanSetting("EnableRPCInvite", false))
+            {
                 checkBox3.Checked = true;
+            }
             else
+            {
                 checkBox3.Checked = false;
+            }
             LogWriter.WriteToFile("SettingsPanel loaded");
         }
 
@@ -45,7 +59,7 @@ namespace EnderIce2.SDRSharpPlugin
             Utils.SaveSetting("EnableRPC", checkBox1.Checked);
             label1.Text = "Restart required";
             LogWriter.WriteToFile($"checkbox on SettingsPanel clicked {checkBox1.Checked}");
-            //Utils.GetBooleanSetting("EnableRPC");
+            /* Utils.GetBooleanSetting("EnableRPC"); */
         }
 
         private void Button1_Click(object sender, EventArgs e)
@@ -61,10 +75,15 @@ namespace EnderIce2.SDRSharpPlugin
         private void TextBox1_KeyPress(object sender, KeyPressEventArgs e)
         {
             if (!char.IsControl(e.KeyChar) && !char.IsDigit(e.KeyChar) && (e.KeyChar != '.'))
+            {
                 e.Handled = true;
+            }
+
             if ((e.KeyChar == '.') && ((sender as TextBox).Text.IndexOf('.') > -1))
+            {
                 e.Handled = true;
             }
+        }
 
         private async void TextBox1_KeyDown(object sender, KeyEventArgs e)
         {
@@ -73,7 +92,7 @@ namespace EnderIce2.SDRSharpPlugin
                 Utils.SaveSetting("ClientID", textBox1.Text);
                 e.Handled = true;
                 e.SuppressKeyPress = true;
-                await Task.Delay(200);
+                await Task.Delay(200).ConfigureAwait(false);
                 textBox1.Text = Utils.GetStringSetting("ClientID");
                 label1.Text = "Saved.";
             }

TopWindowMessages.cs

@@ -25,8 +25,8 @@ namespace EnderIce2.SDRSharpPlugin
                 LogWriter.WriteToFile(value);
             }
         }
-        private bool AnswerA = false;
+        private bool AnswerA;
-        private bool AnswerD = false;
+        private bool AnswerD;
         public async Task<bool> RequestAnswer(DiscordRpcClient client, JoinRequestMessage args)
         {
             LogWriter.WriteToFile("Incoming RPC request from " + args.User.Username);
@@ -37,7 +37,7 @@ namespace EnderIce2.SDRSharpPlugin
             {
                 LogWriter.WriteToFile("waiting...");
                 Application.DoEvents();
-                await Task.Delay(200);
+                await Task.Delay(200).ConfigureAwait(false);
             }
             bool tmpansw = AnswerA;
             LogWriter.WriteToFile($"Client sent an answer. {tmpansw}");
@@ -46,18 +46,21 @@ namespace EnderIce2.SDRSharpPlugin
             AnswerD = false;
             button1.Visible = false;
             button2.Visible = false;
-#pragma warning disable CS4014 // Because this call is not awaited, execution of the current method continues before the call is completed
             SetDefaultTextInLabel(tmpansw);
-#pragma warning restore CS4014 // Because this call is not awaited, execution of the current method continues before the call is completed
             return tmpansw;
         }
         private async Task SetDefaultTextInLabel(bool accepted)
         {
             if (accepted)
+            {
                 ChangeLabel = $"SDR# RPC | Request accepted";
+            }
             else
+            {
                 ChangeLabel = $"SDR# RPC | Request declined";
-            await Task.Delay(5000);
+            }
+
+            await Task.Delay(5000).ConfigureAwait(false);
             ChangeLabel = $"SDR# RPC | Ready";
         }
     }