Add support for IPrefetchableSupport, ITestPlugProvider and ITestPlugProvider2

Author: xoofx

src/NPlug/AudioControllerClassInfo.cs

@@ -0,0 +1,22 @@
+// Copyright (c) Alexandre Mutel. All rights reserved.
+// Licensed under the BSD-Clause 2 license.
+// See license.txt file in the project root for full license information.
+
+using System;
+
+namespace NPlug;
+
+/// <summary>
+/// An <see cref="AudioController"/> plugin class info
+/// </summary>
+public sealed class AudioControllerClassInfo : AudioPluginClassInfo
+{
+    /// <summary>
+    /// Creates a new instance of this plugin info.
+    /// </summary>
+    /// <param name="classId"></param>
+    /// <param name="name"></param>
+    public AudioControllerClassInfo(Guid classId, string name) : base(classId, name, AudioPluginCategory.Controller)
+    {
+    }
+}

src/NPlug/AudioPluginCategory.cs

@@ -0,0 +1,17 @@
+// Copyright (c) Alexandre Mutel. All rights reserved.
+// Licensed under the BSD-Clause 2 license.
+// See license.txt file in the project root for full license information.
+
+namespace NPlug;
+
+/// <summary>
+/// Category of an audio processor.
+/// </summary>
+public enum AudioPluginCategory
+{
+    Processor,
+
+    Controller,
+
+    TestProvider,
+}

src/NPlug/AudioPluginClassInfo.cs

@@ -16,28 +16,34 @@ public abstract class AudioPluginClassInfo
     /// <summary>
     /// Creates a new instance of this plugin info.
     /// </summary>
-    /// <param name="guid"></param>
+    /// <param name="classId"></param>
     /// <param name="name"></param>
     /// <param name="category"></param>
-    internal AudioPluginClassInfo(Guid guid, string name)
+    internal AudioPluginClassInfo(Guid classId, string name, AudioPluginCategory pluginCategory)
     {
-        Id = guid;
+        ClassId = classId;
         Name = name;
         ClassFlags = AudioPluginFlags.None;
         Cardinality = int.MaxValue;
         Vendor = string.Empty;
         Version = EmptyVersion;
+        PluginCategory = pluginCategory;
     }
 
     /// <summary>
     /// see @ref PClassInfo
     /// </summary>
-    public Guid Id { get; }
+    public Guid ClassId { get; }
 
     /// <summary>
     /// Gets or init the category.
     /// </summary>
     public string Name { get; }
+    
+    /// <summary>
+    /// Gets the category of the plugin
+    /// </summary>
+    public AudioPluginCategory PluginCategory { get; }
 
     /// <summary>
     /// flags used for a specific category, must be defined where category is defined
@@ -58,46 +64,4 @@ internal AudioPluginClassInfo(Guid guid, string name)
     /// Version string (e.g. "1.0.0.512" with Major.Minor.Subversion.Build)
     /// </summary>
     public Version Version { get; init; }
-}
-
-/// <summary>
-/// An <see cref="AudioProcessor"/> plugin class info
-/// </summary>
-public sealed class AudioProcessorClassInfo : AudioPluginClassInfo
-{
-    private static readonly Version EmptyVersion = new(0, 0);
-
-    /// <summary>
-    /// Creates a new instance of this plugin info.
-    /// </summary>
-    /// <param name="guid"></param>
-    /// <param name="name"></param>
-    /// <param name="category"></param>
-    public AudioProcessorClassInfo(Guid guid, string name, AudioProcessorCategory category) : base(guid, name)
-    {
-        Category = category;
-    }
-
-    /// <summary>
-    /// Gets or init the category.
-    /// </summary>
-    public AudioProcessorCategory Category { get; init; }
-}
-
-
-/// <summary>
-/// An <see cref="AudioController"/> plugin class info
-/// </summary>
-public sealed class AudioControllerClassInfo : AudioPluginClassInfo
-{
-    private static readonly Version EmptyVersion = new(0, 0);
-
-    /// <summary>
-    /// Creates a new instance of this plugin info.
-    /// </summary>
-    /// <param name="guid"></param>
-    /// <param name="name"></param>
-    public AudioControllerClassInfo(Guid guid, string name) : base(guid, name)
-    {
-    }
 }

src/NPlug/AudioPluginFactory.cs

@@ -9,36 +9,51 @@ namespace NPlug;
 
 public sealed class AudioPluginFactory : IAudioPluginFactory
 {
-    private readonly List<AudioPluginClassInfo> _plugins;
-    private readonly Dictionary<Guid, Func<IAudioPluginComponent>> _mapGuidToComponentFactory;
+    private readonly List<AudioPluginClassInfo> _pluginClassInfos;
+    private readonly Dictionary<Guid, Func<IAudioPluginObject>> _mapGuidToComponentFactory;
 
     public AudioPluginFactory(AudioPluginFactoryInfo factoryInfo)
     {
         FactoryInfo = factoryInfo;
-        _plugins = new List<AudioPluginClassInfo>();
-        _mapGuidToComponentFactory = new Dictionary<Guid, Func<IAudioPluginComponent>>();
+        _pluginClassInfos = new List<AudioPluginClassInfo>();
+        _mapGuidToComponentFactory = new Dictionary<Guid, Func<IAudioPluginObject>>();
     }
 
     public AudioPluginFactoryInfo FactoryInfo { get; }
-    
-    public void RegisterPlugin<TPlugin>(AudioProcessorClassInfo pluginClassInfo) where TPlugin: class, IAudioProcessor, new()
+
+    public IReadOnlyList<AudioPluginClassInfo> PluginClassInfos => _pluginClassInfos;
+
+    public IAudioPluginObject? CreateInstance(Guid pluginId)
+    {
+        return _mapGuidToComponentFactory.TryGetValue(pluginId, out var factory) ? factory() : null;
+    }
+
+    public void RegisterPlugin<TPlugin>(AudioProcessorClassInfo pluginClassInfo, bool registerTests = false) where TPlugin: class, IAudioProcessor, new()
     {
         RegisterPlugin(pluginClassInfo, static () => new TPlugin());
+
+        // Register test plugin on the fly
+        if (registerTests)
+        {
+            var testPluginClassInfo = new AudioTestProviderClassInfo(Guid.NewGuid(), $"{pluginClassInfo.Name} Test Provider");
+            int indexOfAudioProcessor = _pluginClassInfos.Count - 1;
+            RegisterPlugin(testPluginClassInfo, () => new AudioTestProvider(this, indexOfAudioProcessor));
+        }
     }
 
     public void RegisterPlugin<TPlugin>(AudioControllerClassInfo pluginClassInfo) where TPlugin : class, IAudioController, new()
     {
         RegisterPlugin(pluginClassInfo, static () => new TPlugin());
     }
 
-    public void RegisterPlugin(AudioPluginClassInfo pluginClassInfo, Func<IAudioPluginComponent> factory)
+    public void RegisterPlugin(AudioPluginClassInfo pluginClassInfo, Func<IAudioPluginObject> factory)
     {
-        if (_mapGuidToComponentFactory.ContainsKey(pluginClassInfo.Id))
+        if (_mapGuidToComponentFactory.ContainsKey(pluginClassInfo.ClassId))
         {
-            throw new InvalidOperationException($"The plugin {pluginClassInfo.Name} with id: {pluginClassInfo.Id} has been already registered");
+            throw new InvalidOperationException($"The plugin {pluginClassInfo.Name} with id: {pluginClassInfo.ClassId} has been already registered");
         }
-        _mapGuidToComponentFactory.Add(pluginClassInfo.Id, factory);
-        _plugins.Add(pluginClassInfo);
+        _mapGuidToComponentFactory.Add(pluginClassInfo.ClassId, factory);
+        _pluginClassInfos.Add(pluginClassInfo);
     }
 
     /// <summary>
@@ -47,23 +62,61 @@ public void RegisterPlugin(AudioPluginClassInfo pluginClassInfo, Func<IAudioPlug
     /// <param name="factory">The factory to copy registered plugins.</param>
     public void CopyFrom(AudioPluginFactory factory)
     {
-        foreach (var pluginInfo in factory._plugins)
+        foreach (var pluginInfo in factory._pluginClassInfos)
         {
-            var componentFactory = _mapGuidToComponentFactory[pluginInfo.Id];
+            var componentFactory = _mapGuidToComponentFactory[pluginInfo.ClassId];
             RegisterPlugin(pluginInfo, componentFactory);
         }
     }
 
-    int IAudioPluginFactory.PluginClassInfoCount => _plugins.Count;
+    int IAudioPluginFactory.PluginClassInfoCount => _pluginClassInfos.Count;
 
     AudioPluginClassInfo IAudioPluginFactory.GetPluginClassInfo(int index)
     {
-        if ((uint)index >= (uint)_plugins.Count) throw new ArgumentOutOfRangeException(nameof(index));
-        return _plugins[index];
+        if ((uint)index >= (uint)_pluginClassInfos.Count) throw new ArgumentOutOfRangeException(nameof(index));
+        return _pluginClassInfos[index];
     }
-
-    IAudioPluginComponent? IAudioPluginFactory.CreateInstance(Guid pluginId)
+    
+    /// <summary>
+    /// Base class for <see cref="IAudioTestProvider"/>.
+    /// </summary>
+    private class AudioTestProvider : IAudioTestProvider
     {
-        return _mapGuidToComponentFactory.TryGetValue(pluginId, out var factory) ? factory() : null;
+        private readonly AudioPluginFactory _factory;
+        private readonly AudioProcessorClassInfo _audioProcessorClassInfo;
+        private IAudioProcessor? _audioProcessor;
+        private IAudioController? _audioController;
+
+        public AudioTestProvider(AudioPluginFactory factory, int indexToAudioProcessor)
+        {
+            _factory = factory;
+            _audioProcessorClassInfo = (AudioProcessorClassInfo)_factory.PluginClassInfos[indexToAudioProcessor];
+        }
+        
+        public IAudioProcessor GetAudioProcessor()
+        {
+            if (_audioProcessor != null)
+            {
+                return _audioProcessor;
+            }
+            _audioProcessor = (IAudioProcessor)_factory.CreateInstance(_audioProcessorClassInfo.ClassId)!;
+            return _audioProcessor;
+        }
+
+        public IAudioController GetAudioController()
+        {
+            if (_audioController != null)
+            {
+                return _audioController;
+            }
+            _audioController = (IAudioController)_factory.CreateInstance(GetAudioProcessor().ControllerId)!;
+            return _audioController;
+        }
+
+        public AudioProcessorCategory GetAudioProcessorCategory() => _audioProcessorClassInfo.Category;
+
+        public Guid GetAudioProcessorClassId() => _audioProcessorClassInfo.ClassId;
+
+        public IAudioPluginFactory GetPluginFactory() => _factory;
     }
 }

src/NPlug/AudioProcessorClassInfo.cs

@@ -0,0 +1,29 @@
+// Copyright (c) Alexandre Mutel. All rights reserved.
+// Licensed under the BSD-Clause 2 license.
+// See license.txt file in the project root for full license information.
+
+using System;
+
+namespace NPlug;
+
+/// <summary>
+/// An <see cref="AudioProcessor"/> plugin class info
+/// </summary>
+public sealed class AudioProcessorClassInfo : AudioPluginClassInfo
+{
+    /// <summary>
+    /// Creates a new instance of this plugin info.
+    /// </summary>
+    /// <param name="classId"></param>
+    /// <param name="name"></param>
+    /// <param name="category"></param>
+    public AudioProcessorClassInfo(Guid classId, string name, AudioProcessorCategory category) : base(classId, name, AudioPluginCategory.Processor)
+    {
+        Category = category;
+    }
+
+    /// <summary>
+    /// Gets or init the category.
+    /// </summary>
+    public AudioProcessorCategory Category { get; init; }
+}

src/NPlug/AudioProcessorPrefetchableSupport.cs

@@ -0,0 +1,26 @@
+// Copyright (c) Alexandre Mutel. All rights reserved.
+// Licensed under the BSD-Clause 2 license.
+// See license.txt file in the project root for full license information.
+
+namespace NPlug;
+
+/// <summary>
+/// Prefetchable Support Enum
+/// </summary>
+public enum AudioProcessorPrefetchableSupport
+{
+    /// <summary>
+    /// every instance of the plug does not support prefetch processing
+    /// </summary>
+    IsNeverPrefetchable = 0,
+
+    /// <summary>
+    /// in the current state the plug support prefetch processing
+    /// </summary>
+    IsYetPrefetchable,
+
+    /// <summary>
+    /// in the current state the plug does not support prefetch processing
+    /// </summary>
+    IsNotYetPrefetchable,
+}

src/NPlug/AudioTestProviderClassInfo.cs

@@ -0,0 +1,22 @@
+// Copyright (c) Alexandre Mutel. All rights reserved.
+// Licensed under the BSD-Clause 2 license.
+// See license.txt file in the project root for full license information.
+
+using System;
+
+namespace NPlug;
+
+/// <summary>
+/// An <see cref="AudioController"/> plugin class info
+/// </summary>
+public sealed class AudioTestProviderClassInfo : AudioPluginClassInfo
+{
+    /// <summary>
+    /// Creates a new instance of this plugin info.
+    /// </summary>
+    /// <param name="classId"></param>
+    /// <param name="name"></param>
+    public AudioTestProviderClassInfo(Guid classId, string name) : base(classId, name, AudioPluginCategory.TestProvider)
+    {
+    }
+}

src/NPlug/IAudioPluginComponent.cs

@@ -11,7 +11,7 @@ namespace NPlug;
 /// A list of supported host context interfaces should be included in the documentation
 /// of a specific category. 
 /// </summary>
-public interface IAudioPluginComponent
+public interface IAudioPluginComponent : IAudioPluginObject
 {
     /// <summary>
     /// The host passes a number of interfaces as context to initialize the plug-in class.

src/NPlug/IAudioPluginFactory.cs

@@ -14,5 +14,5 @@ public interface IAudioPluginFactory
 
     AudioPluginClassInfo GetPluginClassInfo(int index);
 
-    IAudioPluginComponent? CreateInstance(Guid pluginId);
+    IAudioPluginObject? CreateInstance(Guid pluginId);
 }

src/NPlug/IAudioPluginObject.cs

@@ -0,0 +1,12 @@
+// Copyright (c) Alexandre Mutel. All rights reserved.
+// Licensed under the BSD-Clause 2 license.
+// See license.txt file in the project root for full license information.
+
+namespace NPlug;
+
+/// <summary>
+/// Base interface for instantiable plugin object from the <see cref="IAudioPluginFactory.CreateInstance"/>.
+/// </summary>
+public interface IAudioPluginObject
+{
+}