boost(Device::Switching): Be sure the order of switching device follow the selection made by the user in the settings menu

Author: Belphemur

SoundSwitch.Common/Framework/Audio/Device/DeviceFullInfo.cs

@@ -1,4 +1,5 @@
-using NAudio.CoreAudioApi;
+using System;
+using NAudio.CoreAudioApi;
 using Newtonsoft.Json;
 using SoundSwitch.Common.Framework.Audio.Icon;
 
@@ -13,7 +14,7 @@ public class DeviceFullInfo : DeviceInfo
         public System.Drawing.Icon SmallIcon => AudioDeviceIconExtractor.ExtractIconFromPath(IconPath, Type, false);
 
         [JsonConstructor]
-        public DeviceFullInfo(string name, string id, DataFlow type, string iconPath, DeviceState state, bool isUsb) : base(name, id, type, isUsb)
+        public DeviceFullInfo(string name, string id, DataFlow type, string iconPath, DeviceState state, bool isUsb) : base(name, id, type, isUsb, DateTime.UtcNow)
         {
             IconPath = iconPath;
             State = state;

SoundSwitch.Common/Framework/Audio/Device/DeviceInfo.cs

@@ -21,6 +21,8 @@ public class DeviceInfo : IEquatable<DeviceInfo>, IComparable<DeviceInfo>
 
         public bool IsUsb { get; } = true;
 
+        public DateTime DiscoveredAt { get; set; } = DateTime.UtcNow;
+
         public string NameClean
         {
             get
@@ -43,15 +45,6 @@ public string NameClean
             }
         }
 
-        [JsonConstructor]
-        public DeviceInfo(string name, string id, DataFlow type, bool isUsb)
-        {
-            Name = name;
-            Id = id;
-            Type = type;
-            IsUsb = isUsb;
-        }
-
         public DeviceInfo(MMDevice device)
         {
             Name = device.FriendlyName;
@@ -62,6 +55,16 @@ public DeviceInfo(MMDevice device)
             IsUsb = enumerator == "USB";
         }
 
+        [JsonConstructor]
+        public DeviceInfo(string name, string id, DataFlow type, bool isUsb, DateTime discoveredAt)
+        {
+            Name = name;
+            Id = id;
+            Type = type;
+            IsUsb = isUsb;
+            DiscoveredAt = discoveredAt;
+        }
+
 
         public static bool operator ==(DeviceInfo left, DeviceInfo right)
         {
@@ -79,18 +82,6 @@ public override string ToString()
             return NameClean;
         }
 
-        public int CompareTo(DeviceInfo other)
-        {
-            if (ReferenceEquals(this, other)) return 0;
-            if (ReferenceEquals(null, other)) return 1;
-            var nameComparison = string.Compare(NameClean, other.NameClean, StringComparison.Ordinal);
-            if (nameComparison != 0) return nameComparison;
-            var idComparison = string.Compare(Id, other.Id, StringComparison.Ordinal);
-            if (idComparison != 0) return idComparison;
-            return Type.CompareTo(other.Type);
-        }
-
-
 
         public bool Equals(DeviceInfo other)
         {
@@ -119,5 +110,16 @@ public override int GetHashCode()
                 return hashCode;
             }
         }
+
+        public int CompareTo(DeviceInfo other)
+        {
+            if (ReferenceEquals(this, other)) return 0;
+            if (ReferenceEquals(null, other)) return 1;
+            var discoveredAtComparison = DiscoveredAt.CompareTo(other.DiscoveredAt);
+            if (discoveredAtComparison != 0) return discoveredAtComparison;
+            var nameComparison = string.Compare(Name, other.Name, StringComparison.Ordinal);
+            if (nameComparison != 0) return nameComparison;
+            return string.Compare(Id, other.Id, StringComparison.Ordinal);
+        }
     }
 }

SoundSwitch/Framework/Configuration/ISoundSwitchConfiguration.cs

@@ -36,7 +36,7 @@ public interface ISoundSwitchConfiguration : IConfiguration
         [Obsolete]
         HashSet<string> SelectedRecordingDeviceListId { get; }
 
-        HashSet<DeviceInfo> SelectedDevices { get; }
+        SortedSet<DeviceInfo> SelectedDevices { get; }
 
         bool FirstRun { get; set; }
         HotKey PlaybackHotKey { get; set; }

SoundSwitch/Framework/Configuration/SoundSwitchConfiguration.cs

@@ -60,15 +60,15 @@ public SoundSwitchConfiguration()
             RecordingHotKey = new HotKey(Keys.F7, HotKey.ModifierKeys.Alt | HotKey.ModifierKeys.Control);
             MuteRecordingHotKey = new HotKey(Keys.M, HotKey.ModifierKeys.Control | HotKey.ModifierKeys.Alt);
 
-            SelectedDevices = new HashSet<DeviceInfo>();
+            SelectedDevices = new SortedSet<DeviceInfo>();
             SwitchIcon = IconChangerFactory.ActionEnum.Never;
             MigratedFields = new HashSet<string>();
         }
 
 
         public HashSet<string> SelectedPlaybackDeviceListId { get; }
         public HashSet<string> SelectedRecordingDeviceListId { get; }
-        public HashSet<DeviceInfo> SelectedDevices { get; }
+        public SortedSet<DeviceInfo> SelectedDevices { get; }
         public bool FirstRun { get; set; }
         public HotKey PlaybackHotKey { get; set; }
         public HotKey RecordingHotKey { get; set; }
@@ -124,15 +124,15 @@ public bool Migrate()
             if (SelectedPlaybackDeviceListId.Count > 0)
             {
                 SelectedDevices.UnionWith(
-                    SelectedPlaybackDeviceListId.Select((s => new DeviceInfo("", s, DataFlow.Render, false))));
+                    SelectedPlaybackDeviceListId.Select((s => new DeviceInfo("", s, DataFlow.Render, false, DateTime.UtcNow))));
                 SelectedPlaybackDeviceListId.Clear();
                 migrated = true;
             }
 
             if (SelectedRecordingDeviceListId.Count > 0)
             {
                 SelectedDevices.UnionWith(
-                    SelectedRecordingDeviceListId.Select((s => new DeviceInfo("", s, DataFlow.Capture, false))));
+                    SelectedRecordingDeviceListId.Select((s => new DeviceInfo("", s, DataFlow.Capture, false, DateTime.UtcNow))));
                 SelectedRecordingDeviceListId.Clear();
                 migrated = true;
             }

SoundSwitch/Framework/DeviceCyclerManager/DeviceCycler/ADeviceCycler.cs

@@ -40,21 +40,21 @@ public abstract class ADeviceCycler : IDeviceCycler
         /// <param name="audioDevices"></param>
         /// <param name="type"></param>
         /// <returns></returns>
-        protected DeviceFullInfo GetNextDevice(IReadOnlyCollection<DeviceFullInfo> audioDevices, DataFlow type)
+        protected DeviceInfo GetNextDevice(IEnumerable<DeviceInfo> audioDevices, DataFlow type)
         {
-
-            var defaultDev = audioDevices.FirstOrDefault(device => AudioSwitcher.Instance.IsDefault(device.Id, (EDataFlow)type, ERole.eConsole)) ??
-                             audioDevices.Last();
-            var next = audioDevices.SkipWhile((device, i) => device.Id != defaultDev.Id).Skip(1).FirstOrDefault() ??
-                       audioDevices.ElementAt(0);
+            var deviceInfos = audioDevices as DeviceInfo[] ?? audioDevices.ToArray();
+            var defaultDev = deviceInfos.FirstOrDefault(device => AudioSwitcher.Instance.IsDefault(device.Id, (EDataFlow)type, ERole.eConsole)) ??
+                             deviceInfos.Last();
+            var next = deviceInfos.SkipWhile((device, i) => device.Id != defaultDev.Id).Skip(1).FirstOrDefault() ??
+                       deviceInfos.ElementAt(0);
             return next;
         }
 
         /// <summary>
         /// Attempts to set active device to the specified name
         /// </summary>
         /// <param name="device"></param>
-        public bool SetActiveDevice(DeviceFullInfo device)
+        public bool SetActiveDevice(DeviceInfo device)
         {
 
             Log.Information("Set Default device: {Device}", device);

SoundSwitch/Framework/DeviceCyclerManager/DeviceCycler/DeviceCyclerAvailable.cs

@@ -13,11 +13,10 @@
 ********************************************************************/
 
 using System;
-using System.Collections.Generic;
+using System.Linq;
 using NAudio.CoreAudioApi;
-using SoundSwitch.Common.Framework.Audio.Device;
-using SoundSwitch.Model;
 using SoundSwitch.Localization;
+using SoundSwitch.Model;
 
 namespace SoundSwitch.Framework.DeviceCyclerManager.DeviceCycler
 {
@@ -32,28 +31,19 @@ public class DeviceCyclerAvailable : ADeviceCycler
         /// <param name="type"></param>
         public override bool CycleAudioDevice(DataFlow type)
         {
-            IReadOnlyCollection<DeviceFullInfo> audioDevices;
-            switch (type)
+            var audioDevices = (type switch
             {
-                case DataFlow.Render:
-                    audioDevices = AppModel.Instance.AvailablePlaybackDevices;
-                    break;
-                case DataFlow.Capture:
-                    audioDevices = AppModel.Instance.AvailableRecordingDevices;
-                    break;
-                default:
-                    throw new ArgumentOutOfRangeException(nameof(type), type, null);
-            }
+                DataFlow.Render  => AppModel.Instance.AvailablePlaybackDevices,
+                DataFlow.Capture => AppModel.Instance.AvailableRecordingDevices,
+                _                => throw new ArgumentOutOfRangeException(nameof(type), type, null)
+            }).ToArray();
 
-            switch (audioDevices.Count)
+            return audioDevices switch
             {
-                case 0:
-                    throw new AppModel.NoDevicesException();
-                case 1:
-                    return false;
-            }
-
-            return SetActiveDevice(GetNextDevice(audioDevices, type));
+                {Length: 0} => throw new AppModel.NoDevicesException(),
+                {Length: 1} => false,
+                _           => SetActiveDevice(GetNextDevice(audioDevices, type))
+            };
         }
     }
 }

SoundSwitch/Framework/DeviceCyclerManager/DeviceCycler/IDeviceCycler.cs

@@ -30,6 +30,6 @@ public interface IDeviceCycler : IEnumImpl<DeviceCyclerTypeEnum>
         ///     Attempts to set active device to the specified name
         /// </summary>
         /// <param name="device"></param>
-        bool SetActiveDevice(DeviceFullInfo device);
+        bool SetActiveDevice(DeviceInfo device);
     }
 }

SoundSwitch/Framework/DeviceCyclerManager/DeviceCyclerManager.cs

@@ -51,7 +51,7 @@ public bool CycleDevice(DataFlow type)
         /// </summary>
         /// <param name="device"></param>
         /// <returns></returns>
-        public bool SetAsDefault(DeviceFullInfo device)
+        public bool SetAsDefault(DeviceInfo device)
         {
             return _deviceCyclerFactory.Get(CurrentCycler).SetActiveDevice(device);
         }

SoundSwitch/Model/AppModel.cs

@@ -123,12 +123,9 @@ public bool IncludeBetaVersions
 
         public ISet<DeviceInfo> SelectedDevices => AppConfigs.Configuration.SelectedDevices;
 
-        public IReadOnlyCollection<DeviceFullInfo> AvailablePlaybackDevices =>
-            ActiveAudioDeviceLister.PlaybackDevices.Where(device => SelectedDevices.FirstOrDefault(device.Equals) != null).ToArray();
+        public IEnumerable<DeviceInfo> AvailablePlaybackDevices => SelectedDevices.Intersect(ActiveAudioDeviceLister.PlaybackDevices);
 
-
-        public IReadOnlyCollection<DeviceFullInfo> AvailableRecordingDevices =>
-            ActiveAudioDeviceLister.RecordingDevices.Where(device => SelectedDevices.FirstOrDefault(device.Equals) != null).ToArray();
+        public IEnumerable<DeviceInfo> AvailableRecordingDevices => SelectedDevices.Intersect(ActiveAudioDeviceLister.RecordingDevices);
 
         public bool SetCommunications
         {
@@ -332,6 +329,7 @@ public bool SelectDevice(DeviceFullInfo device)
         {
             try
             {
+                device.DiscoveredAt = DateTime.UtcNow;
                 SelectedDevices.Add(device);
             }
             catch (ArgumentException)
@@ -355,7 +353,8 @@ public bool UnselectDevice(DeviceFullInfo device)
             bool result;
             try
             {
-                result = SelectedDevices.Where(device.Equals).Aggregate(true, (current, deviceInfo) => current & SelectedDevices.Remove(deviceInfo));
+                var list = SelectedDevices.Where(device.Equals).ToArray();
+                result = list.Aggregate(true, (b, info) => b & SelectedDevices.Remove(info));
             }
             catch (ArgumentException)
             {
@@ -475,7 +474,7 @@ private void HandleHotkeyPress(object sender, WindowsAPIAdapter.KeyPressedEventA
         ///     Attempts to set active device to the specified name
         /// </summary>
         /// <param name="device"></param>
-        public bool SetActiveDevice(DeviceFullInfo device)
+        public bool SetActiveDevice(DeviceInfo device)
         {
             try
             {

SoundSwitch/Model/IAppModel.cs

@@ -39,12 +39,12 @@ public interface IAppModel : IDisposable
         /// <summary>
         /// An union between the Active <see cref="IAudioDevice" /> of Windows and <see cref="SelectedPlaybackDevicesList" />
         /// </summary>
-        IReadOnlyCollection<DeviceFullInfo> AvailablePlaybackDevices { get; }
+        IEnumerable<DeviceInfo> AvailablePlaybackDevices { get; }
 
         /// <summary>
         /// An union between the Active <see cref="IAudioDevice" /> of Windows and <see cref="SelectedRecordingDevicesList" />
         /// </summary>
-        IReadOnlyCollection<DeviceFullInfo> AvailableRecordingDevices { get; }
+        IEnumerable<DeviceInfo> AvailableRecordingDevices { get; }
 
         /// <summary>
         /// If the Playback device need also to be set for Communications.
@@ -191,7 +191,7 @@ public interface IAppModel : IDisposable
         ///     Attempts to set active device to the specified name
         /// </summary>
         /// <param name="device"></param>
-        bool SetActiveDevice(DeviceFullInfo device);
+        bool SetActiveDevice(DeviceInfo device);
 
         /// <summary>
         ///     Cycles the active device to the next device. Returns true if succesfully switched (at least

SoundSwitch/UI/Component/TrayIcon.cs

@@ -302,8 +302,8 @@ public void UpdateDeviceSelectionList()
         {
             Log.Information("Set tray icon menu devices");
             _selectionMenu.Items.Clear();
-            var playbackDevices = AppModel.Instance.AvailablePlaybackDevices;
-            var recordingDevices = AppModel.Instance.AvailableRecordingDevices;
+            var playbackDevices = AppModel.Instance.AvailablePlaybackDevices.ToArray();
+            var recordingDevices = AppModel.Instance.AvailableRecordingDevices.ToArray();
             var profiles = _profileTrayIconBuilder.GetMenuItems().ToArray();
 
             if (profiles.Length > 0)
@@ -312,8 +312,8 @@ public void UpdateDeviceSelectionList()
                 _selectionMenu.Items.Add(new ToolStripSeparator());
             }
 
-            if (playbackDevices.Count < 0 &&
-                recordingDevices.Count < 0)
+            if (playbackDevices.Length < 0 &&
+                recordingDevices.Length < 0)
             {
                 Log.Information("Device list empty");
                 return;
@@ -322,7 +322,7 @@ public void UpdateDeviceSelectionList()
             var defaultPlayback = AudioSwitcher.Instance.GetDefaultAudioEndpoint(EDataFlow.eRender, ERole.eConsole);
             _selectionMenu.Items.AddRange(playbackDevices.Select(info => new ToolStripDeviceItem(DeviceClicked, info, info.Equals(defaultPlayback))).ToArray());
 
-            if (recordingDevices.Count > 0)
+            if (recordingDevices.Length > 0)
             {
                 var defaultRecording = AudioSwitcher.Instance.GetDefaultAudioEndpoint(EDataFlow.eCapture, ERole.eConsole);
 

SoundSwitch/Util/ToolStripDeviceItem.cs

@@ -25,7 +25,7 @@ internal class ToolStripDeviceItem : ToolStripMenuItem
     {
         private readonly bool _isDefault;
 
-        public ToolStripDeviceItem(EventHandler onClick, DeviceFullInfo audioDevice, bool isDefault)
+        public ToolStripDeviceItem(EventHandler onClick, DeviceInfo audioDevice, bool isDefault)
             : base(audioDevice.NameClean, null, onClick)
         {
             AudioDevice = audioDevice;
@@ -34,6 +34,6 @@ public ToolStripDeviceItem(EventHandler onClick, DeviceFullInfo audioDevice, boo
 
         public override Image Image => _isDefault ? Resources.Check : null;
 
-        public DeviceFullInfo AudioDevice { get; }
+        public DeviceInfo AudioDevice { get; }
     }
 }