chore: cleanup synapse

Author: andrewbabbittdev

src/ChromaControl.SDK.Synapse.Sample/Program.cs

@@ -8,6 +8,7 @@
 var builder = Host.CreateApplicationBuilder(args);
 
 builder.Services.AddSynapseSDK();
+
 builder.Services.AddHostedService<Worker>();
 
 await builder.Build().RunAsync();

src/ChromaControl.SDK.Synapse.Sample/Worker.cs

@@ -3,86 +3,69 @@
 // See the LICENSE file in the project root for more information.
 
 using ChromaControl.SDK.Synapse.Enums;
-using ChromaControl.SDK.Synapse.Structs;
 using System.Drawing;
 
 namespace ChromaControl.SDK.Synapse.Sample;
 
 /// <summary>
 /// The worker.
 /// </summary>
-public partial class Worker : IHostedService
+public partial class Worker : BackgroundService
 {
-    private readonly ILogger<Worker> _logger;
-    private readonly ISynapseService _synapse;
-
-    private Color _colorCache;
-
-    [LoggerMessage(Level = LogLevel.Information, Message = "Starting Synapse Service...")]
-    private static partial void LogStartMessage(ILogger logger);
+    private bool _serviceReady;
+    private Color _cachedColor;
 
-    [LoggerMessage(Level = LogLevel.Information, Message = "Stopping Synapse Service...")]
-    private static partial void LogStopMessage(ILogger logger);
-
-    [LoggerMessage(Level = LogLevel.Information, Message = "Synapse Status Changed To {status}")]
-    private static partial void LogStatusMessage(ILogger logger, SynapseStatus status);
+    private readonly ILogger<Worker> _logger;
+    private readonly ISynapseService _service;
 
-    [LoggerMessage(Level = LogLevel.Information, Message = "Synapse Color Set To [{r}, {g}, {b}]")]
-    private static partial void LogEffectMessage(ILogger logger, byte r, byte g, byte b);
+    [LoggerMessage(EventId = 0, Level = LogLevel.Information, Message = "Color changed to [R = {r}, G = {g}, B = {b}]")]
+    private static partial void LogColorChangedMessage(ILogger logger, byte r, byte g, byte b);
 
     /// <summary>
     /// Creates a <see cref="Worker"/> instance.
     /// </summary>
     /// <param name="logger">The <see cref="ILogger{TCategoryName}"/>.</param>
-    /// <param name="synapse">The <see cref="ISynapseService"/>.</param>
-    public Worker(ILogger<Worker> logger, ISynapseService synapse)
+    /// <param name="service">The <see cref="ISynapseService"/>.</param>
+    public Worker(ILogger<Worker> logger, ISynapseService service)
     {
         _logger = logger;
-        _synapse = synapse;
-        _synapse.StatusChanged += StatusChanged;
-        _synapse.EffectReceived += EffectReceived;
+        _service = service;
+
+        _service.StatusChanged += OnStatusChanged;
+        _service.ColorsReceived += OnColorsReceived;
     }
 
-    /// <summary>
-    /// Starts the worker.
-    /// </summary>
-    /// <param name="cancellationToken">The <see cref="CancellationToken"/>.</param>
-    /// <returns>A <see cref="Task"/> representing the worker starting.</returns>
-    public Task StartAsync(CancellationToken cancellationToken)
+    /// <inheritdoc/>
+    protected override async Task ExecuteAsync(CancellationToken stoppingToken)
     {
-        LogStartMessage(_logger);
-
-        _synapse.StartService(new("00000000-0000-0000-0000-000000000000"));
+        var currentColor = _cachedColor;
 
-        return Task.CompletedTask;
-    }
+        while (!stoppingToken.IsCancellationRequested)
+        {
+            if (!_serviceReady)
+            {
+                await Task.Delay(1000, stoppingToken);
+                continue;
+            }
 
-    /// <summary>
-    /// Stops the worker.
-    /// </summary>
-    /// <param name="cancellationToken">The <see cref="CancellationToken"/>.</param>
-    /// <returns>A <see cref="Task"/> representing the worker stopping.</returns>
-    public Task StopAsync(CancellationToken cancellationToken)
-    {
-        LogStopMessage(_logger);
+            if (currentColor != _cachedColor)
+            {
+                currentColor = _cachedColor;
 
-        _synapse.StopService();
+                LogColorChangedMessage(_logger, currentColor.R, currentColor.G, currentColor.B);
+            }
 
-        return Task.CompletedTask;
+            await Task.Delay(1000, stoppingToken);
+        }
     }
 
-    private void StatusChanged(object? sender, SynapseStatus e)
+    private void OnStatusChanged(object? sender, SynapseStatus e)
     {
-        LogStatusMessage(_logger, e);
+        _serviceReady = true;
     }
 
-    private void EffectReceived(object? sender, SynapseEffect e)
+    private void OnColorsReceived(object? sender, Color[] e)
     {
-        if (_colorCache != e.Color1)
-        {
-            _colorCache = e.Color1;
-
-            LogEffectMessage(_logger, e.Color1.R, e.Color1.G, e.Color1.B);
-        }
+        _cachedColor = e[0];
     }
 }

src/ChromaControl.SDK.Synapse/ChromaControl.SDK.Synapse.csproj

@@ -6,7 +6,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <PackageReference Include="Microsoft.Extensions.DependencyInjection.Abstractions" Version="8.0.1" />
+    <PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" Version="8.0.0" />
   </ItemGroup>
 
 </Project>

src/ChromaControl.SDK.Synapse/Extensions/ServiceCollectionSynapseExtensions.cs

@@ -2,6 +2,7 @@
 // The Chroma Control Contributors licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
+using ChromaControl.SDK.OpenRGB.Hosting;
 using Microsoft.Extensions.DependencyInjection;
 
 namespace ChromaControl.SDK.Synapse.Extensions;
@@ -20,6 +21,8 @@ public static IServiceCollection AddSynapseSDK(this IServiceCollection services)
     {
         services.AddSingleton<ISynapseService, SynapseService>();
 
+        services.AddHostedService<SynapseHostService>();
+
         return services;
     }
 }

src/ChromaControl.SDK.Synapse/Hosting/SynapseHostService.cs

@@ -0,0 +1,82 @@
+// Licensed to the Chroma Control Contributors under one or more agreements.
+// The Chroma Control Contributors licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using ChromaControl.SDK.Synapse;
+using ChromaControl.SDK.Synapse.Enums;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Hosting;
+using Microsoft.Extensions.Logging;
+
+namespace ChromaControl.SDK.OpenRGB.Hosting;
+
+/// <summary>
+/// The host service for Synapse.
+/// </summary>
+public partial class SynapseHostService : IHostedService
+{
+    private readonly ILogger<SynapseHostService> _logger;
+    private readonly IConfiguration _configuration;
+    private readonly SynapseService _synapse;
+
+    [LoggerMessage(EventId = 0, Level = LogLevel.Information, Message = "Synapse SDK is starting up...")]
+    private static partial void LogStartMessage(ILogger logger);
+
+    [LoggerMessage(EventId = 1, Level = LogLevel.Error, Message = "Synapse SDK failed to start, invalid configuration.")]
+    private static partial void LogStartErrorMessage(ILogger logger);
+
+    [LoggerMessage(EventId = 1, Level = LogLevel.Information, Message = "Synapse SDK is shutting down...")]
+    private static partial void LogStopMessage(ILogger logger);
+
+    /// <summary>
+    /// Creates a <see cref="SynapseHostService"/> instance.
+    /// </summary>
+    /// <param name="logger">The <see cref="ILogger{TCategoryName}"/>.</param>
+    /// <param name="configuration">The <see cref="IConfiguration"/>.</param>
+    /// <param name="synapse">The <see cref="SynapseService"/>.</param>
+    public SynapseHostService(ILogger<SynapseHostService> logger, IConfiguration configuration, ISynapseService synapse)
+    {
+        _logger = logger;
+        _configuration = configuration;
+        _synapse = (SynapseService)synapse;
+    }
+
+    /// <summary>
+    /// Starts the service.
+    /// </summary>
+    /// <param name="cancellationToken">The <see cref="CancellationToken"/>.</param>
+    /// <returns>A <see cref="Task"/> representing the worker starting.</returns>
+    public Task StartAsync(CancellationToken cancellationToken)
+    {
+        LogStartMessage(_logger);
+
+        var key = _configuration["CHROMACONTROL_KEY_SYNAPSE"];
+
+        var parseResult = Guid.TryParse(key, out var appId);
+
+        var startResult = parseResult
+            ? _synapse.StartService(appId)
+            : _synapse.StartService(new());
+
+        if (startResult != SynapseResult.Success)
+        {
+            LogStartErrorMessage(_logger);
+        }
+
+        return Task.CompletedTask;
+    }
+
+    /// <summary>
+    /// Stops the service.
+    /// </summary>
+    /// <param name="cancellationToken">The <see cref="CancellationToken"/>.</param>
+    /// <returns>A <see cref="Task"/> representing the worker stopping.</returns>
+    public Task StopAsync(CancellationToken cancellationToken)
+    {
+        LogStopMessage(_logger);
+
+        _synapse.StopService();
+
+        return Task.CompletedTask;
+    }
+}

src/ChromaControl.SDK.Synapse/ISynapseService.cs

@@ -3,7 +3,7 @@
 // See the LICENSE file in the project root for more information.
 
 using ChromaControl.SDK.Synapse.Enums;
-using ChromaControl.SDK.Synapse.Structs;
+using System.Drawing;
 
 namespace ChromaControl.SDK.Synapse;
 
@@ -28,20 +28,7 @@ public interface ISynapseService
     event EventHandler<SynapseStatus>? StatusChanged;
 
     /// <summary>
-    /// Occurs when an effect is received.
+    /// Occurs when color data is received.
     /// </summary>
-    event EventHandler<SynapseEffect>? EffectReceived;
-
-    /// <summary>
-    /// Starts the Synapse service.
-    /// </summary>
-    /// <param name="appId">Application Id for authentication.</param>
-    /// <returns>A <see cref="SynapseResult"/>.</returns>
-    SynapseResult StartService(in Guid appId);
-
-    /// <summary>
-    /// Stops the Synapse service.
-    /// </summary>
-    /// <returns>A <see cref="SynapseResult"/>.</returns>
-    SynapseResult StopService();
+    event EventHandler<Color[]>? ColorsReceived;
 }

src/ChromaControl.SDK.Synapse/Structs/SynapseEffect.cs

@@ -5,10 +5,7 @@
 using ChromaControl.SDK.Synapse.Enums;
 using ChromaControl.SDK.Synapse.Internal;
 using ChromaControl.SDK.Synapse.Internal.Enums;
-using ChromaControl.SDK.Synapse.Structs;
 using System.Drawing;
-using System.Runtime.CompilerServices;
-using System.Runtime.InteropServices;
 
 namespace ChromaControl.SDK.Synapse;
 
@@ -25,7 +22,7 @@ public partial class SynapseService : ISynapseService
     public event EventHandler<SynapseStatus>? StatusChanged;
 
     /// <inheritdoc/>
-    public event EventHandler<SynapseEffect>? EffectReceived;
+    public event EventHandler<Color[]>? ColorsReceived;
 
     private NativeSynapseService.RegisterEventNotificationCallback RegisterEventNotificationCallbackState { get; set; }
 
@@ -37,8 +34,7 @@ public SynapseService()
         RegisterEventNotificationCallbackState = new(OnEventNotification);
     }
 
-    /// <inheritdoc/>
-    public SynapseResult StartService(in Guid appId)
+    internal SynapseResult StartService(in Guid appId)
     {
         var initResult = NativeSynapseService.Init(appId);
 
@@ -57,8 +53,7 @@ public SynapseResult StartService(in Guid appId)
         return registerResult;
     }
 
-    /// <inheritdoc/>
-    public SynapseResult StopService()
+    internal SynapseResult StopService()
     {
         var unRegisterResult = NativeSynapseService.UnRegisterEventNotification();
 
@@ -78,23 +73,22 @@ public SynapseResult StopService()
         return unInitResult;
     }
 
-    private SynapseResult OnEventNotification(SynapseEventType type, nint pData)
+    private unsafe SynapseResult OnEventNotification(SynapseEventType type, nint pData)
     {
         if (type == SynapseEventType.Effect)
         {
-            var effectDataPtr = Unsafe.AddByteOffset(ref Unsafe.NullRef<int>(), pData);
-            var effectData = MemoryMarshal.CreateSpan(ref effectDataPtr, 5);
+            var span = new ReadOnlySpan<byte>(pData.ToPointer(), 20);
 
-            var effect = new SynapseEffect
+            var colors = new Color[]
             {
-                Color1 = Color.FromArgb((effectData[0] >> 0) & 0xff, (effectData[0] >> 8) & 0xff, (effectData[0] >> 16) & 0xff),
-                Color2 = Color.FromArgb((effectData[1] >> 0) & 0xff, (effectData[1] >> 8) & 0xff, (effectData[1] >> 16) & 0xff),
-                Color3 = Color.FromArgb((effectData[2] >> 0) & 0xff, (effectData[2] >> 8) & 0xff, (effectData[2] >> 16) & 0xff),
-                Color4 = Color.FromArgb((effectData[3] >> 0) & 0xff, (effectData[3] >> 8) & 0xff, (effectData[3] >> 16) & 0xff),
-                Color5 = Color.FromArgb((effectData[4] >> 0) & 0xff, (effectData[4] >> 8) & 0xff, (effectData[4] >> 16) & 0xff)
+                Color.FromArgb(span[3], span[0], span[1], span[2]),
+                Color.FromArgb(span[7], span[4], span[5], span[6]),
+                Color.FromArgb(span[11], span[8], span[9], span[10]),
+                Color.FromArgb(span[15], span[12], span[13], span[14]),
+                Color.FromArgb(span[10], span[16], span[17], span[18]),
             };
 
-            EffectReceived?.Invoke(this, effect);
+            ColorsReceived?.Invoke(this, colors);
         }
         else if (type == SynapseEventType.Status)
         {