Make ByPass not mandatory for the model

Author: xoofx

src/NPlug.HelloWorldPlugin/HelloWorldProcessor.cs

@@ -57,6 +57,8 @@ public class HelloWorldModel : AudioProcessorModel
     {
         public HelloWorldModel() : base("HelloWorld")
         {
+            AddByPassParameter();
+
             SubUnit1 = AddUnit(new AudioUnit("SubUnit1"));
             SubUnit11 = SubUnit1.AddUnit(new AudioUnit("SubUnit1.1"));
             SubUnit2 = AddUnit(new AudioUnit("SubUnit2"));

src/NPlug/AudioProcessor.Processing.cs

@@ -10,9 +10,8 @@ public abstract partial class AudioProcessor<TAudioProcessorModel>
 {
     public bool IsProcessing { get; private set; }
 
-    public bool IsByPass => Model.ByPassParameter.Value;
-
-
+    public bool ShouldByPass => Model.ByPassParameter?.Value ?? false;
+    
     protected virtual void PreProcess(in AudioProcessData data)
     {
     }
@@ -38,14 +37,12 @@ protected virtual void Process(in AudioProcessData data)
 
     protected virtual void ProcessCore(in AudioProcessData data)
     {
-
     }
 
     protected virtual void ProcessRecalculate(in AudioProcessData data)
     {
     }
-
-
+    
     protected virtual bool ProcessParameterChanges(in AudioProcessData data)
     {
         var parameterChanges = data.Input.ParameterChanges;
@@ -88,7 +85,7 @@ protected virtual void ProcessEvent(in AudioEvent audioEvent)
 
     protected virtual bool ProcessByPass(in AudioProcessData data)
     {
-        if (!IsByPass || data.SampleCount == 0) return false;
+        if (!ShouldByPass || data.SampleCount == 0) return false;
 
         ref readonly var setupData = ref ProcessSetupData;
         var inputCount = data.Input.BufferCount;
@@ -157,7 +154,6 @@ protected virtual void PostProcessCheckSilence(in AudioProcessData data)
         }
     }
 
-
     bool IAudioProcessor.SetupProcessing(in AudioProcessSetupData processSetupData)
     {
         if (IsSampleSizeSupported(processSetupData.SampleSize))

src/NPlug/AudioProcessorModel.cs

@@ -12,6 +12,10 @@
 
 namespace NPlug;
 
+/// <summary>
+/// The <see cref="AudioProcessor{TAudioProcessorModel}"/> model that will be shared between
+/// the controller and processor. Provides a definition of units, parameters and program lists.
+/// </summary>
 public abstract class AudioProcessorModel : AudioUnit, IDisposable
 {
     private readonly List<AudioUnit> _allUnits;
@@ -31,19 +35,9 @@ protected AudioProcessorModel(string unitName, AudioProgramList? programList = n
         _unitIdToIndex = new Dictionary<AudioUnitId, int>();
         _allProgramLists = new List<AudioProgramList>();
         _programListIdToIndex = new Dictionary<AudioProgramListId, int>();
-
-        ByPassParameter = new AudioBoolParameter("ByPass", flags: AudioParameterFlags.IsBypass | AudioParameterFlags.CanAutomate);
-        AddParameter(ByPassParameter);
     }
 
-    public AudioBoolParameter ByPassParameter { get; }
-
-    public void Initialize()
-    {
-        if (IsInitialized) throw new InvalidOperationException("This unit is already initialized");
-        RegisterUnit(this);
-        InitializeBuffer();
-    }
+    public AudioBoolParameter? ByPassParameter { get; private set; }
 
     public int ParameterCount => _allParameters.Count;
 
@@ -72,7 +66,32 @@ public void Initialize()
     /// Event when a program is changed for a unit.
     /// </summary>
     public event Action<AudioUnit>? SelectedProgramChanged;
-    
+
+    /// <summary>
+    /// Add a default by-pass parameter (e.g for effects).
+    /// </summary>
+    /// <param name="name">The name of the parameter. Default is "ByPass".</param>
+    public void AddByPassParameter(string name = "ByPass")
+    {
+        // Don't add a bypass parameter if it was already added.
+        if (ByPassParameter is null)
+        {
+            ByPassParameter = new AudioBoolParameter(name, flags: AudioParameterFlags.IsBypass | AudioParameterFlags.CanAutomate);
+            AddParameter(ByPassParameter);
+        }
+    }
+
+    /// <summary>
+    /// Initialize this model.
+    /// </summary>
+    /// <exception cref="InvalidOperationException">If the model has been already initialized.</exception>
+    public void Initialize()
+    {
+        if (IsInitialized) throw new InvalidOperationException("This unit is already initialized");
+        RegisterUnit(this);
+        InitializeBuffer();
+    }
+
     public bool TryGetParameterById(AudioParameterId id, [NotNullWhen(true)] out AudioParameter? parameter)
     {
         parameter = null;