Readded support for older CUE-SDKs

RGB.NET.Devices.Corsair_Legacy/Native/_CUESDK.cs

@@ -0,0 +1,193 @@
+#pragma warning disable IDE1006 // Naming Styles
+// ReSharper disable UnusedMethodReturnValue.Global
+// ReSharper disable UnusedMember.Global
+
+using System;
+using System.Collections.Generic;
+using System.IO;
+using System.Linq;
+using System.Runtime.InteropServices;
+using RGB.NET.Core;
+
+namespace RGB.NET.Devices.CorsairLegacy.Native;
+
+// ReSharper disable once InconsistentNaming
+internal static class _CUESDK
+{
+    #region Libary Management
+
+    private static IntPtr _handle = IntPtr.Zero;
+
+    /// <summary>
+    /// Reloads the SDK.
+    /// </summary>
+    internal static void Reload()
+    {
+        UnloadCUESDK();
+        LoadCUESDK();
+    }
+
+    private static void LoadCUESDK()
+    {
+        if (_handle != IntPtr.Zero) return;
+
+        List<string> possiblePathList = GetPossibleLibraryPaths().ToList();
+
+        string? dllPath = possiblePathList.FirstOrDefault(File.Exists);
+        if (dllPath == null) throw new RGBDeviceException($"Can't find the CUE-SDK at one of the expected locations:\r\n '{string.Join("\r\n", possiblePathList.Select(Path.GetFullPath))}'");
+
+        if (!NativeLibrary.TryLoad(dllPath, out _handle))
+#if NET6_0
+            throw new RGBDeviceException($"Corsair LoadLibrary failed with error code {Marshal.GetLastPInvokeError()}");
+#else
+            throw new RGBDeviceException($"Corsair LoadLibrary failed with error code {Marshal.GetLastWin32Error()}");
+#endif
+
+        if (!NativeLibrary.TryGetExport(_handle, "CorsairSetLedsColorsBufferByDeviceIndex", out _corsairSetLedsColorsBufferByDeviceIndexPointer)) throw new RGBDeviceException("Failed to load Corsair function 'CorsairSetLedsColorsBufferByDeviceIndex'");
+        if (!NativeLibrary.TryGetExport(_handle, "CorsairSetLedsColorsFlushBuffer", out _corsairSetLedsColorsFlushBufferPointer)) throw new RGBDeviceException("Failed to load Corsair function 'CorsairSetLedsColorsFlushBuffer'");
+        if (!NativeLibrary.TryGetExport(_handle, "CorsairGetLedsColorsByDeviceIndex", out _corsairGetLedsColorsByDeviceIndexPointer)) throw new RGBDeviceException("Failed to load Corsair function 'CorsairGetLedsColorsByDeviceIndex'");
+        if (!NativeLibrary.TryGetExport(_handle, "CorsairSetLayerPriority", out _corsairSetLayerPriorityPointer)) throw new RGBDeviceException("Failed to load Corsair function 'CorsairSetLayerPriority'");
+        if (!NativeLibrary.TryGetExport(_handle, "CorsairGetDeviceCount", out _corsairGetDeviceCountPointer)) throw new RGBDeviceException("Failed to load Corsair function 'CorsairGetDeviceCount'");
+        if (!NativeLibrary.TryGetExport(_handle, "CorsairGetDeviceInfo", out _corsairGetDeviceInfoPointer)) throw new RGBDeviceException("Failed to load Corsair function 'CorsairGetDeviceInfo'");
+        if (!NativeLibrary.TryGetExport(_handle, "CorsairGetLedIdForKeyName", out _corsairGetLedIdForKeyNamePointer)) throw new RGBDeviceException("Failed to load Corsair function 'CorsairGetLedIdForKeyName'");
+        if (!NativeLibrary.TryGetExport(_handle, "CorsairGetLedPositionsByDeviceIndex", out _corsairGetLedPositionsByDeviceIndexPointer)) throw new RGBDeviceException("Failed to load Corsair function 'CorsairGetLedPositionsByDeviceIndex'");
+        if (!NativeLibrary.TryGetExport(_handle, "CorsairRequestControl", out _corsairRequestControlPointer)) throw new RGBDeviceException("Failed to load Corsair function 'CorsairRequestControl'");
+        if (!NativeLibrary.TryGetExport(_handle, "CorsairReleaseControl", out _corsairReleaseControlPointer)) throw new RGBDeviceException("Failed to load Corsair function 'CorsairReleaseControl'");
+        if (!NativeLibrary.TryGetExport(_handle, "CorsairPerformProtocolHandshake", out _corsairPerformProtocolHandshakePointer)) throw new RGBDeviceException("Failed to load Corsair function 'CorsairPerformProtocolHandshake'");
+        if (!NativeLibrary.TryGetExport(_handle, "CorsairGetLastError", out _corsairGetLastErrorPointer)) throw new RGBDeviceException("Failed to load Corsair function 'CorsairGetLastError'");
+    }
+
+    private static IEnumerable<string> GetPossibleLibraryPaths()
+    {
+        IEnumerable<string> possibleLibraryPaths;
+
+        if (OperatingSystem.IsWindows())
+            possibleLibraryPaths = Environment.Is64BitProcess ? CorsairLegacyDeviceProvider.PossibleX64NativePaths : CorsairLegacyDeviceProvider.PossibleX86NativePaths;
+        else
+            possibleLibraryPaths = Enumerable.Empty<string>();
+
+        return possibleLibraryPaths.Select(Environment.ExpandEnvironmentVariables);
+    }
+
+    internal static void UnloadCUESDK()
+    {
+        if (_handle == IntPtr.Zero) return;
+
+        _corsairSetLedsColorsBufferByDeviceIndexPointer = IntPtr.Zero;
+        _corsairSetLedsColorsFlushBufferPointer = IntPtr.Zero;
+        _corsairGetLedsColorsByDeviceIndexPointer = IntPtr.Zero;
+        _corsairSetLayerPriorityPointer = IntPtr.Zero;
+        _corsairGetDeviceCountPointer = IntPtr.Zero;
+        _corsairGetDeviceInfoPointer = IntPtr.Zero;
+        _corsairGetLedIdForKeyNamePointer = IntPtr.Zero;
+        _corsairGetLedPositionsByDeviceIndexPointer = IntPtr.Zero;
+        _corsairRequestControlPointer = IntPtr.Zero;
+        _corsairReleaseControlPointer = IntPtr.Zero;
+        _corsairPerformProtocolHandshakePointer = IntPtr.Zero;
+        _corsairGetLastErrorPointer = IntPtr.Zero;
+
+        NativeLibrary.Free(_handle);
+        _handle = IntPtr.Zero;
+    }
+
+    #endregion
+
+    #region SDK-METHODS
+
+    #region Pointers
+
+    private static IntPtr _corsairSetLedsColorsBufferByDeviceIndexPointer;
+    private static IntPtr _corsairSetLedsColorsFlushBufferPointer;
+    private static IntPtr _corsairGetLedsColorsByDeviceIndexPointer;
+    private static IntPtr _corsairSetLayerPriorityPointer;
+    private static IntPtr _corsairGetDeviceCountPointer;
+    private static IntPtr _corsairGetDeviceInfoPointer;
+    private static IntPtr _corsairGetLedIdForKeyNamePointer;
+    private static IntPtr _corsairGetLedPositionsByDeviceIndexPointer;
+    private static IntPtr _corsairRequestControlPointer;
+    private static IntPtr _corsairReleaseControlPointer;
+    private static IntPtr _corsairPerformProtocolHandshakePointer;
+    private static IntPtr _corsairGetLastErrorPointer;
+
+    #endregion
+
+    /// <summary>
+    /// CUE-SDK: set specified LEDs to some colors.
+    /// This function set LEDs colors in the buffer which is written to the devices via CorsairSetLedsColorsFlushBuffer or CorsairSetLedsColorsFlushBufferAsync.
+    /// Typical usecase is next: CorsairSetLedsColorsFlushBuffer or CorsairSetLedsColorsFlushBufferAsync is called to write LEDs colors to the device
+    /// and follows after one or more calls of CorsairSetLedsColorsBufferByDeviceIndex to set the LEDs buffer.
+    /// This function does not take logical layout into account.
+    /// </summary>
+    internal static unsafe bool CorsairSetLedsColorsBufferByDeviceIndex(int deviceIndex, int size, IntPtr ledsColors)
+        => ((delegate* unmanaged[Cdecl]<int, int, IntPtr, bool>)ThrowIfZero(_corsairSetLedsColorsBufferByDeviceIndexPointer))(deviceIndex, size, ledsColors);
+
+    /// <summary>
+    /// CUE-SDK: writes to the devices LEDs colors buffer which is previously filled by the CorsairSetLedsColorsBufferByDeviceIndex function.
+    /// This function executes synchronously, if you are concerned about delays consider using CorsairSetLedsColorsFlushBufferAsync
+    /// </summary>
+    internal static unsafe bool CorsairSetLedsColorsFlushBuffer() => ((delegate* unmanaged[Cdecl]<bool>)ThrowIfZero(_corsairSetLedsColorsFlushBufferPointer))();
+
+    /// <summary>
+    /// CUE-SDK: get current color for the list of requested LEDs.
+    /// The color should represent the actual state of the hardware LED, which could be a combination of SDK and/or CUE input.
+    /// This function works for keyboard, mouse, mousemat, headset, headset stand and DIY-devices.
+    /// </summary>
+    internal static unsafe bool CorsairGetLedsColorsByDeviceIndex(int deviceIndex, int size, IntPtr ledsColors)
+        => ((delegate* unmanaged[Cdecl]<int, int, IntPtr, bool>)ThrowIfZero(_corsairGetLedsColorsByDeviceIndexPointer))(deviceIndex, size, ledsColors);
+
+    /// <summary>
+    /// CUE-SDK: set layer priority for this shared client.
+    /// By default CUE has priority of 127 and all shared clients have priority of 128 if they don’t call this function.
+    /// Layers with higher priority value are shown on top of layers with lower priority.
+    /// </summary>
+    internal static unsafe bool CorsairSetLayerPriority(int priority) => ((delegate* unmanaged[Cdecl]<int, bool>)ThrowIfZero(_corsairSetLayerPriorityPointer))(priority);
+
+    /// <summary>
+    /// CUE-SDK: returns number of connected Corsair devices that support lighting control.
+    /// </summary>
+    internal static unsafe int CorsairGetDeviceCount() => ((delegate* unmanaged[Cdecl]<int>)ThrowIfZero(_corsairGetDeviceCountPointer))();
+
+    /// <summary>
+    /// CUE-SDK: returns information about device at provided index.
+    /// </summary>
+    internal static unsafe IntPtr CorsairGetDeviceInfo(int deviceIndex) => ((delegate* unmanaged[Cdecl]<int, IntPtr>)ThrowIfZero(_corsairGetDeviceInfoPointer))(deviceIndex);
+
+    /// <summary>
+    /// CUE-SDK: provides list of keyboard or mousepad LEDs with their physical positions.
+    /// </summary>
+    internal static unsafe IntPtr CorsairGetLedPositionsByDeviceIndex(int deviceIndex) => ((delegate* unmanaged[Cdecl]<int, IntPtr>)ThrowIfZero(_corsairGetLedPositionsByDeviceIndexPointer))(deviceIndex);
+
+    /// <summary>
+    /// CUE-SDK: retrieves led id for key name taking logical layout into account.
+    /// </summary>
+    internal static unsafe CorsairLedId CorsairGetLedIdForKeyName(char keyName) => ((delegate* unmanaged[Cdecl]<char, CorsairLedId>)ThrowIfZero(_corsairGetLedIdForKeyNamePointer))(keyName);
+
+    /// <summary>
+    /// CUE-SDK: requestes control using specified access mode.
+    /// By default client has shared control over lighting so there is no need to call CorsairRequestControl unless client requires exclusive control.
+    /// </summary>
+    internal static unsafe bool CorsairRequestControl(CorsairAccessMode accessMode) => ((delegate* unmanaged[Cdecl]<CorsairAccessMode, bool>)ThrowIfZero(_corsairRequestControlPointer))(accessMode);
+
+    /// <summary>
+    /// CUE-SDK: releases previously requested control for specified access mode.
+    /// </summary>
+    internal static unsafe bool CorsairReleaseControl(CorsairAccessMode accessMode) => ((delegate* unmanaged[Cdecl]<CorsairAccessMode, bool>)ThrowIfZero(_corsairReleaseControlPointer))(accessMode);
+
+    /// <summary>
+    /// CUE-SDK: checks file and protocol version of CUE to understand which of SDK functions can be used with this version of CUE.
+    /// </summary>
+    internal static unsafe _CorsairProtocolDetails CorsairPerformProtocolHandshake() => ((delegate* unmanaged[Cdecl]<_CorsairProtocolDetails>)ThrowIfZero(_corsairPerformProtocolHandshakePointer))();
+
+    /// <summary>
+    /// CUE-SDK: returns last error that occured while using any of Corsair* functions.
+    /// </summary>
+    internal static unsafe CorsairError CorsairGetLastError() => ((delegate* unmanaged[Cdecl]<CorsairError>)ThrowIfZero(_corsairGetLastErrorPointer))();
+
+    private static IntPtr ThrowIfZero(IntPtr ptr)
+    {
+        if (ptr == IntPtr.Zero) throw new RGBDeviceException("The Corsair-SDK is not initialized.");
+        return ptr;
+    }
+
+    #endregion
+}

RGB.NET.Devices.Corsair_Legacy/Native/_CorsairChannelDeviceInfo.cs

@@ -0,0 +1,27 @@
+#pragma warning disable 169 // Field 'x' is never used
+#pragma warning disable 414 // Field 'x' is assigned but its value never used
+#pragma warning disable 649 // Field 'x' is never assigned
+#pragma warning disable IDE1006 // Naming Styles
+
+using System.Runtime.InteropServices;
+
+namespace RGB.NET.Devices.CorsairLegacy.Native;
+
+// ReSharper disable once InconsistentNaming
+/// <summary>
+/// CUE-SDK: contains information about separate LED-device connected to the channel controlled by the DIY-device.
+/// </summary>
+[StructLayout(LayoutKind.Sequential)]
+
+internal class _CorsairChannelDeviceInfo
+{
+    /// <summary>
+    /// CUE-SDK: type of the LED-device
+    /// </summary>
+    internal CorsairChannelDeviceType type;
+
+    /// <summary>
+    /// CUE-SDK: number of LEDs controlled by LED-device.
+    /// </summary>
+    internal int deviceLedCount;
+}

RGB.NET.Devices.Corsair_Legacy/Native/_CorsairChannelInfo.cs

@@ -0,0 +1,33 @@
+#pragma warning disable 169 // Field 'x' is never used
+#pragma warning disable 414 // Field 'x' is assigned but its value never used
+#pragma warning disable 649 // Field 'x' is never assigned
+#pragma warning disable IDE1006 // Naming Styles
+
+using System;
+using System.Runtime.InteropServices;
+
+namespace RGB.NET.Devices.CorsairLegacy.Native;
+
+// ReSharper disable once InconsistentNaming
+/// <summary>
+/// CUE-SDK: contains information about separate channel of the DIY-device.
+/// </summary>
+[StructLayout(LayoutKind.Sequential)]
+internal class _CorsairChannelInfo
+{
+    /// <summary>
+    /// CUE-SDK: total number of LEDs connected to the channel;
+    /// </summary>
+    internal int totalLedsCount;
+
+    /// <summary>
+    /// CUE-SDK: number of LED-devices (fans, strips, etc.) connected to the channel which is controlled by the DIY device
+    /// </summary>
+    internal int devicesCount;
+
+    /// <summary>
+    /// CUE-SDK: array containing information about each separate LED-device connected to the channel controlled by the DIY device.
+    /// Index of the LED-device in array is same as the index of the LED-device connected to the DIY-device.
+    /// </summary>
+    internal IntPtr devices;
+}

RGB.NET.Devices.Corsair_Legacy/Native/_CorsairChannelsInfo.cs

@@ -0,0 +1,28 @@
+#pragma warning disable 169 // Field 'x' is never used
+#pragma warning disable 414 // Field 'x' is assigned but its value never used
+#pragma warning disable 649 // Field 'x' is never assigned
+#pragma warning disable IDE1006 // Naming Styles
+
+using System;
+using System.Runtime.InteropServices;
+
+namespace RGB.NET.Devices.CorsairLegacy.Native;
+
+// ReSharper disable once InconsistentNaming
+/// <summary>
+/// CUE-SDK: contains information about channels of the DIY-devices.
+/// </summary>
+[StructLayout(LayoutKind.Sequential)]
+internal class _CorsairChannelsInfo
+{
+    /// <summary>
+    /// CUE-SDK: number of channels controlled by the device
+    /// </summary>
+    internal int channelsCount;
+
+    /// <summary>
+    /// CUE-SDK: array containing information about each separate channel of the DIY-device.
+    /// Index of the channel in the array is same as index of the channel on the DIY-device.
+    /// </summary>
+    internal IntPtr channels;
+}

RGB.NET.Devices.Corsair_Legacy/Native/_CorsairDeviceInfo.cs

@@ -0,0 +1,58 @@
+#pragma warning disable 169 // Field 'x' is never used
+#pragma warning disable 414 // Field 'x' is assigned but its value never used
+#pragma warning disable 649 // Field 'x' is never assigned
+#pragma warning disable IDE1006 // Naming Styles
+
+using System;
+using System.Runtime.InteropServices;
+
+namespace RGB.NET.Devices.CorsairLegacy.Native;
+
+// ReSharper disable once InconsistentNaming
+/// <summary>
+/// CUE-SDK: contains information about device
+/// </summary>
+[StructLayout(LayoutKind.Sequential)]
+internal class _CorsairDeviceInfo
+{
+    /// <summary>
+    /// CUE-SDK: enum describing device type
+    /// </summary>
+    internal CorsairDeviceType type;
+
+    /// <summary>
+    /// CUE-SDK: null - terminated device model(like “K95RGB”)
+    /// </summary>
+    internal IntPtr model;
+
+    /// <summary>
+    /// CUE-SDK: enum describing physical layout of the keyboard or mouse
+    /// </summary>
+    internal int physicalLayout;
+
+    /// <summary>
+    /// CUE-SDK: enum describing logical layout of the keyboard as set in CUE settings
+    /// </summary>
+    internal int logicalLayout;
+
+    /// <summary>
+    /// CUE-SDK: mask that describes device capabilities, formed as logical “or” of CorsairDeviceCaps enum values
+    /// </summary>
+    internal int capsMask;
+
+    /// <summary>
+    /// CUE-SDK: number of controllable LEDs on the device
+    /// </summary>
+    internal int ledsCount;
+
+    /// <summary>
+    /// CUE-SDK: structure that describes channels of the DIY-devices
+    /// </summary>
+    internal _CorsairChannelsInfo? channels;
+
+    /// <summary>
+    /// CUE-SDK: null-terminated string that contains unique device identifier that uniquely identifies device at least within session
+    /// </summary>
+    [MarshalAs(UnmanagedType.ByValTStr, SizeConst = 128)]
+    internal string? deviceId;
+}

RGB.NET.Devices.Corsair_Legacy/Native/_CorsairLedColor.cs

@@ -0,0 +1,37 @@
+#pragma warning disable 169 // Field 'x' is never used
+#pragma warning disable 414 // Field 'x' is assigned but its value never used
+#pragma warning disable 649 // Field 'x' is never assigned
+#pragma warning disable IDE1006 // Naming Styles
+// ReSharper disable NotAccessedField.Global
+
+using System.Runtime.InteropServices;
+
+namespace RGB.NET.Devices.CorsairLegacy.Native;
+
+// ReSharper disable once InconsistentNaming    
+/// <summary>
+/// CUE-SDK: contains information about led and its color
+/// </summary>
+[StructLayout(LayoutKind.Sequential)]
+internal class _CorsairLedColor
+{
+    /// <summary>
+    /// CUE-SDK: identifier of LED to set
+    /// </summary>
+    internal int ledId;
+
+    /// <summary>
+    /// CUE-SDK: red   brightness[0..255]
+    /// </summary>
+    internal int r;
+
+    /// <summary>
+    /// CUE-SDK: green brightness[0..255]
+    /// </summary>
+    internal int g;
+
+    /// <summary>
+    /// CUE-SDK: blue  brightness[0..255]
+    /// </summary>
+    internal int b;
+};

RGB.NET.Devices.Corsair_Legacy/Native/_CorsairLedPosition.cs

@@ -0,0 +1,42 @@
+#pragma warning disable 169 // Field 'x' is never used
+#pragma warning disable 414 // Field 'x' is assigned but its value never used
+#pragma warning disable 649 // Field 'x' is never assigned
+#pragma warning disable IDE1006 // Naming Styles
+
+using System.Runtime.InteropServices;
+
+namespace RGB.NET.Devices.CorsairLegacy.Native;
+
+// ReSharper disable once InconsistentNaming
+/// <summary>
+/// CUE-SDK: contains led id and position of led rectangle.Most of the keys are rectangular.
+/// In case if key is not rectangular(like Enter in ISO / UK layout) it returns the smallest rectangle that fully contains the key
+/// </summary>
+[StructLayout(LayoutKind.Sequential)]
+internal class _CorsairLedPosition
+{
+    /// <summary>
+    /// CUE-SDK: identifier of led
+    /// </summary>
+    internal CorsairLedId LedId;
+
+    /// <summary>
+    /// CUE-SDK: values in mm
+    /// </summary>
+    internal double top;
+
+    /// <summary>
+    /// CUE-SDK: values in mm
+    /// </summary>
+    internal double left;
+
+    /// <summary>
+    /// CUE-SDK: values in mm
+    /// </summary>
+    internal double height;
+
+    /// <summary>
+    /// CUE-SDK: values in mm
+    /// </summary>
+    internal double width;
+}

RGB.NET.Devices.Corsair_Legacy/Native/_CorsairLedPositions.cs

@@ -0,0 +1,26 @@
+#pragma warning disable 169 // Field 'x' is never used
+#pragma warning disable 414 // Field 'x' is assigned but its value never used
+#pragma warning disable 649 // Field 'x' is never assigned
+
+using System;
+using System.Runtime.InteropServices;
+
+namespace RGB.NET.Devices.CorsairLegacy.Native;
+
+// ReSharper disable once InconsistentNaming
+/// <summary>
+/// CUE-SDK: contains number of leds and arrays with their positions
+/// </summary>
+[StructLayout(LayoutKind.Sequential)]
+internal class _CorsairLedPositions
+{
+    /// <summary>
+    /// CUE-SDK: integer value.Number of elements in following array
+    /// </summary>
+    internal int numberOfLed;
+
+    /// <summary>
+    /// CUE-SDK: array of led positions
+    /// </summary>
+    internal IntPtr pLedPosition;
+}

RGB.NET.Devices.Corsair_Legacy/Native/_CorsairProtocolDetails.cs

@@ -0,0 +1,43 @@
+#pragma warning disable 169 // Field 'x' is never used
+#pragma warning disable 414 // Field 'x' is assigned but its value never used
+#pragma warning disable 649 // Field 'x' is never assigned
+
+using System;
+using System.Runtime.InteropServices;
+
+namespace RGB.NET.Devices.CorsairLegacy.Native;
+
+// ReSharper disable once InconsistentNaming
+/// <summary>
+/// CUE-SDK: contains information about SDK and CUE versions
+/// </summary>
+[StructLayout(LayoutKind.Sequential)]
+internal struct _CorsairProtocolDetails
+{
+    /// <summary>
+    /// CUE-SDK: null - terminated string containing version of SDK(like “1.0.0.1”). Always contains valid value even if there was no CUE found
+    /// </summary>
+    internal IntPtr sdkVersion;
+
+    /// <summary>
+    /// CUE-SDK: null - terminated string containing version of CUE(like “1.0.0.1”) or NULL if CUE was not found.
+    /// </summary>
+    internal IntPtr serverVersion;
+
+    /// <summary>
+    /// CUE-SDK: integer number that specifies version of protocol that is implemented by current SDK.
+    /// Numbering starts from 1. Always contains valid value even if there was no CUE found
+    /// </summary>
+    internal int sdkProtocolVersion;
+
+    /// <summary>
+    /// CUE-SDK: integer number that specifies version of protocol that is implemented by CUE.
+    /// Numbering starts from 1. If CUE was not found then this value will be 0
+    /// </summary>
+    internal int serverProtocolVersion;
+
+    /// <summary>
+    /// CUE-SDK: boolean value that specifies if there were breaking changes between version of protocol implemented by server and client
+    /// </summary>
+    internal byte breakingChanges;
+};