Major refactoring: making audio sources and NoteFinders instantiable, and adding the ability for there to be more than 1 running at a time. This means several breaking API changes, and a ton of changes throughout, but opens the door to some new capabilities I look forward to using.

Author: CaiB

ColorChord.NET-API/ColorChordAPI.cs

@@ -6,7 +6,7 @@ public static class ColorChordAPI
 {
     /// <summary>Use this version as return value for <see cref="Extensions.IExtension.APIVersion"/> in your extension.</summary>
     /// <remarks>This allows ColorChord.NET to know if the installed version of your extension is compatible.</remarks>
-    public const uint APIVersion = 21;
+    public const uint APIVersion = 22;
 
     public static IConfigurer Configurer;
 }

ColorChord.NET-API/Config/ConfigNames.cs

@@ -4,9 +4,31 @@
 /// <remarks>Using these helps prevent different classes having different config names for the same options.</remarks>
 public static class ConfigNames
 {
+    public const string SECTION_SOURCE = "Source";
+    public const string SECTION_SOURCE_ARR = "Sources";
+    public const string SECTION_NOTE_FINDER = "NoteFinder";
+    public const string SECTION_NOTE_FINDER_ARR = "NoteFinders";
+    public const string SECTION_VISUALIZER = "Visualizer";
+    public const string SECTION_VISUALIZER_ARR = "Visualizers";
+    public const string SECTION_OUTPUT = "Output";
+    public const string SECTION_OUTPUT_ARR = "Outputs";
+    public const string SECTION_CONTROLLER = "Controller";
+    public const string SECTION_CONTROLLER_ARR = "Controllers";
+
     public const string TYPE = "Type";
     public const string NAME = "Name";
     public const string ENABLE = "Enable";
     public const string TARGET = "Target";
     public const string LED_COUNT = "LEDCount";
+
+    /// <summary>Used as the key for when a component needs to know the name of a <see cref="ColorChord.NET.API.Sources.IAudioSource"/> to reference.</summary>
+    public const string SOURCE_NAME = "SourceName";
+    /// <summary>Used as the key for when a component needs to know the name of a <see cref="ColorChord.NET.API.NoteFinder.NoteFinderCommon"/> to reference.</summary>
+    public const string NOTE_FINDER_NAME = "NoteFinderName";
+    /// <summary>Used as the key for when a component needs to know the name of a <see cref="ColorChord.NET.API.Outputs.IOutput"/> to reference.</summary>
+    public const string OUTPUT_NAME = "OutputName";
+    /// <summary>Used as the key for when a component needs to know the name of a <see cref="ColorChord.NET.API.Visualizers.IVisualizer"/> to reference.</summary>
+    public const string VIZ_NAME = "VisualizerName";
+    /// <summary>Used as the key for when a component needs to know the name of a <see cref="ColorChord.NET.API.Controllers.Controller"/> to reference.</summary>
+    public const string CONTROLLER_NAME = "ControllerName";
 }

ColorChord.NET-API/Config/IConfigurer.cs

@@ -1,5 +1,9 @@
-using ColorChord.NET.API.Outputs;
+using ColorChord.NET.API.Controllers;
+using ColorChord.NET.API.NoteFinder;
+using ColorChord.NET.API.Outputs;
+using ColorChord.NET.API.Sources;
 using ColorChord.NET.API.Visualizers;
+using ColorChord.NET.API.Visualizers.Formats;
 
 namespace ColorChord.NET.API.Config;
 
@@ -15,16 +19,38 @@ public interface IConfigurer
     /// <exception cref="NotImplementedException">If the attribute is one that is not yet supported.</exception>
     public bool Configure(object targetObj, Dictionary<string, object> config, bool warnAboutRemainder = true);
 
-    /// <summary>Used by outputs. Reads the config, and finds the visualizer instance that this output should attach to.</summary>
-    /// <param name="target">The output that will attach to the visualizer.</param>
-    /// <param name="config">The config entries which will be used in finding the appropriate visualizer.</param>
-    /// <returns>The visualizer that this output should attach to.</returns>
-    public IVisualizer? FindVisualizer(IOutput target, Dictionary<string, object> config);
+    /// <summary>Reads the given config and finds the corresponding loaded <see cref="IAudioSource"/> instance.</summary>
+    /// <remarks>Intended to be used by <see cref="NoteFinderCommon"/> instances to find their audio source to attach to.</remarks>
+    /// <param name="config">The config section of a component which needs to find an audio source, the <see cref="ConfigNames.SOURCE_NAME"/> key will be used to find it by name. If the key is missing and there is only one audio source present, it is returned.</param>
+    /// <returns>The audio source instance if it was found, null otherwise.</returns>
+    public IAudioSource? FindSource(Dictionary<string, object> config);
+
+    /// <summary>Reads the given config and finds the corresponding loaded <see cref="NoteFinderCommon"/> instance.</summary>
+    /// <remarks>Intended to be used by <see cref="IVisualizer"/> instances to find their NoteFinder to attach to.</remarks>
+    /// <param name="config">The config section of a component which needs to find a NoteFinder, the <see cref="ConfigNames.NOTE_FINDER_NAME"/> key will be used to find it by name. If the key is missing and there is only one NoteFinder present, it is returned.</param>
+    /// <returns>The NoteFinder instance if it was found, null otherwise.</returns>
+    public NoteFinderCommon? FindNoteFinder(Dictionary<string, object> config);
+
+    /// <summary>Reads the given config and finds the corresponding loaded <see cref="IVisualizer"/> instance.</summary>
+    /// <remarks>Intended to be used by <see cref="IOutput"/> instances to find their visualizer to attach to.</remarks>
+    /// <param name="config">The config section of a component which needs to find a visualizer, the <see cref="ConfigNames.VIZ_NAME"/> key will be used to find it by name.</param>
+    /// <returns>The visualizer instance if it was found, null otherwise.</returns>
+    public IVisualizer? FindVisualizer(Dictionary<string, object> config);
 
     /// <summary>Used by outputs. Reads the config, and finds the visualizer instance that this output should attach to.</summary>
     /// <param name="target">The output that will attach to the visualizer.</param>
     /// <param name="config">The config entries which will be used in finding the appropriate visualizer.</param>
     /// <param name="acceptableFormat">The <see cref="IVisualizerFormat"/> type that is accepted by this output.</param>
-    /// <returns>The visualizer that this output should attach to.</returns>
+    /// <returns>The visualizer that this output should attach to if it was found, null otherwise.</returns>
     public IVisualizer? FindVisualizer(IOutput target, Dictionary<string, object> config, Type acceptableFormat);
+
+    /// <summary>Reads the given config and finds the corresponding loaded <see cref="IOutput"/> instance.</summary>
+    /// <param name="config">The config section of a component which needs to find an output, the <see cref="ConfigNames.OUTPUT_NAME"/> key will be used to find it by name.</param>
+    /// <returns>The output instance if it was found, null otherwise.</returns>
+    public IOutput? FindOutput(Dictionary<string, object> config);
+
+    /// <summary>Reads the given config and finds the corresponding loaded <see cref="Controller"/> instance.</summary>
+    /// <param name="config">The config section of a component which needs to find a controller, the <see cref="ConfigNames.CONTROLLER_NAME"/> key will be used to find it by name.</param>
+    /// <returns>The controller instance if it was found, null otherwise.</returns>
+    public Controller? FindController(Dictionary<string, object> config);
 }

ColorChord.NET-API/NoteFinder/NoteFinderCommon.cs

@@ -5,11 +5,13 @@ namespace ColorChord.NET.API.NoteFinder;
 
 public abstract class NoteFinderCommon : IConfigurableAttr
 {
+    public abstract string Name { get; protected init; }
+
     /// <summary> When data was last added to the buffer. Used to detect idle state. </summary>
-    public static DateTime LastDataAdd { get; set; }
+    public DateTime LastDataAdd { get; private set; }
 
     /// <summary> The speed (in ms between runs) at which the note finder needs to run, set by the fastest visualizer. </summary>
-    public static uint ShortestPeriod { get; protected set; } = 100;
+    public uint ShortestPeriod { get; protected set; } = 100;
 
     /// <summary> The frequency spectrum data, before folding into a single octave. </summary>
     public abstract ReadOnlySpan<float> AllBinValues { get; }
@@ -23,7 +25,7 @@ public abstract class NoteFinderCommon : IConfigurableAttr
     /// <summary> Used to keep track of locations of notes that stay between frames in <see cref="Notes"/>, as that array's order may change. </summary>
     public abstract ReadOnlySpan<int> PersistentNoteIDs { get; }
 
-    public static AutoResetEvent InputDataEvent { get; protected set; } = new(false);
+    public AutoResetEvent InputDataEvent { get; protected set; } = new(false);
 
     /// <summary>How many note slots there are. Usually not all are in use.</summary>
     public abstract int NoteCount { get; } // TODO: Finish docs
@@ -41,10 +43,10 @@ public abstract class NoteFinderCommon : IConfigurableAttr
 
 
     private const int INTERMEDIATE_BUFFER_COUNT = 4;
-    private static readonly IntermediateBuffer[] IntermediateBuffers = new IntermediateBuffer[INTERMEDIATE_BUFFER_COUNT];
-    private static readonly int[] IntermediateBuffersToRead = new int[INTERMEDIATE_BUFFER_COUNT];
+    private readonly IntermediateBuffer[] IntermediateBuffers = new IntermediateBuffer[INTERMEDIATE_BUFFER_COUNT];
+    private readonly int[] IntermediateBuffersToRead = new int[INTERMEDIATE_BUFFER_COUNT];
 
-    public static void SetupBuffers()
+    public void SetupBuffers()
     {
         for (int i = 0; i < INTERMEDIATE_BUFFER_COUNT; i++)
         {
@@ -53,7 +55,7 @@ public static void SetupBuffers()
         }
     }
 
-    public static short[]? GetBufferToWrite(out int bufferRef)
+    public short[]? GetBufferToWrite(out int bufferRef)
     {
         for (int i = 0; i < INTERMEDIATE_BUFFER_COUNT; i++)
         {
@@ -68,7 +70,7 @@ public static void SetupBuffers()
         return null;
     }
 
-    public static short[]? GetBufferToRead(out int bufferRef, out uint amountToRead, out bool moreAvailable)
+    public short[]? GetBufferToRead(out int bufferRef, out uint amountToRead, out bool moreAvailable)
     {
         lock (IntermediateBuffersToRead)
         {
@@ -91,7 +93,7 @@ public static void SetupBuffers()
         }
     }
 
-    public static bool IsBufferAvailableToWrite()
+    public bool IsBufferAvailableToWrite()
     {
         for (int i = 0; i < INTERMEDIATE_BUFFER_COUNT; i++)
         {
@@ -100,16 +102,17 @@ public static bool IsBufferAvailableToWrite()
         return false;
     }
 
-    public static void FinishBufferRead(int bufferRef)
+    public void FinishBufferRead(int bufferRef)
     {
         IntermediateBuffers[bufferRef].ReadMode = false;
     }
 
-    public static void FinishBufferWrite(int bufferRef, uint amountWritten)
+    public void FinishBufferWrite(int bufferRef, uint amountWritten)
     {
         if (bufferRef == -1) { return; }
         IntermediateBuffers[bufferRef].DataCount = amountWritten;
         IntermediateBuffers[bufferRef].ReadMode = true;
+        this.LastDataAdd = DateTime.UtcNow;
         lock (IntermediateBuffersToRead)
         {
             for (int i = 0; i < INTERMEDIATE_BUFFER_COUNT; i++)

ColorChord.NET-API/Sources/IAudioSource.cs

@@ -1,9 +1,13 @@
 using ColorChord.NET.API.Config;
+using ColorChord.NET.API.NoteFinder;
 
 namespace ColorChord.NET.API.Sources;
 
 public interface IAudioSource : IConfigurableAttr
 {
+    string Name { get; }
     void Start();
     void Stop();
+    uint GetSampleRate();
+    void AttachNoteFinder(NoteFinderCommon noteFinder);
 }

ColorChord.NET-API/ThreadedInstanceAttribute.cs

@@ -0,0 +1,8 @@
+namespace ColorChord.NET.API.Utility;
+
+public interface IThreadedInstance
+{
+    /// <summary> This method is called on the managed instance thread after the constructor is finished. </summary>
+    /// <remarks> For example, this is useful if you need to run a continued loop on the instance thread. </remarks>
+    public void InstThreadPostInit();
+}

ColorChord.NET-API/Utility/IThreadedInstance.cs

@@ -1,11 +1,13 @@
 using ColorChord.NET.API.Config;
+using ColorChord.NET.API.NoteFinder;
 using ColorChord.NET.API.Outputs;
 
 namespace ColorChord.NET.API.Visualizers;
 
 public interface IVisualizer : IConfigurableAttr
 {
     string Name { get; }
+    NoteFinderCommon? NoteFinder { get; }
     void Start();
     void Stop();
     void AttachOutput(IOutput output);