Changed error details for MmException

Docs/FadeInOutSampleProvider.md

@@ -14,6 +14,14 @@ var fade = new FadeInOutSampleProvider(audio, true);
 fade.BeginFadeIn(2000);
 ```
 
+After fade in is complete, `FadeInComplete` event is triggered:
+```c#
+fade.FadeInComplete += (sender, e) => {
+    Console.WriteLine("Fade in was done!");
+};
+fade.BeginFadeIn(2000);
+```
+
 Now we can pass our `FadeInOutSampleProvider` to an output device and start playing. We'll hear the audio fading in over the first two seconds.
 
 ```c#
@@ -28,6 +36,15 @@ At some point in the future, we might want to fade out, and we can trigger that
 fade.BeginFadeOut(2000);
 ```
 
+It also triggers `FadeOutComplete` event, when fade out is complete
+
+```c#
+fade.FadeOutComplete += (sender, e) => {
+    Console.WriteLine("Fade out was done!");
+};
+fade.BeginFadeOut(2000);
+```
+
 Once the audio has faded out, the `FadeInOutSampleProvider` continues to read from its source but emits silence until it reaches its end, or until you call `BeginFadeIn` again.
 
 ### Taking it further

NAudio.Asio/ASIODriverExt.cs

@@ -31,6 +31,9 @@ public class AsioDriverExt
         private int bufferSize;
         private int outputChannelOffset;
         private int inputChannelOffset;
+        /// <summary>
+        /// Reset Request Callback
+        /// </summary>
         public Action ResetRequestCallback;
 
         /// <summary>

NAudio.Asio/NAudio.Asio.csproj

@@ -3,7 +3,7 @@
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
     <AllowUnsafeBlocks>true</AllowUnsafeBlocks>
-    <Version>2.2.1</Version>
+    <Version>2.2.1-SA</Version>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <Authors>Mark Heath</Authors>

NAudio.Core/FileFormats/Wav/WaveFileChunkReader.cs

@@ -1,13 +1,15 @@
 using System;
 using System.Collections.Generic;
-using System.Text;
+using System.Diagnostics;
 using System.IO;
 using NAudio.Utils;
 using NAudio.Wave;
-using System.Diagnostics;
 
 namespace NAudio.FileFormats.Wav
 {
+    /// <summary>
+    /// Reader of RIFF chunks from a WAV file
+    /// </summary>
     public class WaveFileChunkReader
     {
         private WaveFormat waveFormat;
@@ -19,12 +21,18 @@ public class WaveFileChunkReader
         private readonly bool storeAllChunks;
         private long riffSize;
 
+        /// <summary>
+        /// Creates a new WaveFileChunkReader
+        /// </summary>
         public WaveFileChunkReader()
         {
             storeAllChunks = true;
             strictMode = false;
         }
 
+        /// <summary>
+        /// Read the WAV header
+        /// </summary>
         public void ReadWaveHeader(Stream stream)
         {
             this.dataChunkPosition = -1;

NAudio.Core/MmException.cs

@@ -22,7 +22,7 @@ public MmException(MmResult result, string function)
 
         private static string ErrorMessage(MmResult result, string function)
         {
-            return $"{result} calling {function}";
+            return $"Windows MMAPI returned \"{result}\" after call to \"{function}\"";
         }
 
         /// <summary>

NAudio.Core/NAudio.Core.csproj

@@ -3,7 +3,7 @@
   <PropertyGroup>
     <TargetFramework>netstandard2.0</TargetFramework>
     <Authors>Mark Heath</Authors>
-    <Version>2.2.1</Version>
+    <Version>2.2.1-SA</Version>
     <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <SignAssembly>true</SignAssembly>

NAudio.Core/Wave/SampleProviders/FadeInOutSampleProvider.cs

@@ -1,4 +1,6 @@
-namespace NAudio.Wave.SampleProviders
+using System;
+
+namespace NAudio.Wave.SampleProviders
 {
     /// <summary>
     /// Sample Provider to allow fading in and out
@@ -13,6 +15,16 @@ enum FadeState
             FadingOut,
         }
 
+        /// <summary>
+        /// Raised when scheduled fade-in is done
+        /// </summary>
+        public event EventHandler FadeInComplete;
+
+        /// <summary>
+        /// Raised when scheduled fade-out is done
+        /// </summary>
+        public event EventHandler FadeOutComplete;
+
         private readonly object lockObject = new object();
         private readonly ISampleProvider source;
         private int fadeSamplePosition;
@@ -108,6 +120,8 @@ private void FadeOut(float[] buffer, int offset, int sourceSamplesRead)
                 if (fadeSamplePosition > fadeSampleCount)
                 {
                     fadeState = FadeState.Silence;
+                    FadeOutComplete?.Invoke(this, EventArgs.Empty);
+
                     // clear out the end
                     ClearBuffer(buffer, sample + offset, sourceSamplesRead - sample);
                     break;
@@ -129,6 +143,8 @@ private void FadeIn(float[] buffer, int offset, int sourceSamplesRead)
                 if (fadeSamplePosition > fadeSampleCount)
                 {
                     fadeState = FadeState.FullVolume;
+                    FadeInComplete?.Invoke(this, EventArgs.Empty);
+
                     // no need to multiply any more
                     break;
                 }

NAudio.Core/Wave/WaveStreams/Mp3FileReaderBase.cs

@@ -73,6 +73,13 @@ public Mp3FileReaderBase(Stream inputStream, FrameDecompressorBuilder frameDecom
 
         }
 
+        /// <summary>
+        /// Constructor that takes an input stream and a frame decompressor builder
+        /// </summary>
+        /// <param name="inputStream">Input stream</param>
+        /// <param name="frameDecompressorBuilder">Factory method to build a frame decompressor</param>
+        /// <param name="ownInputStream">Whether we own the stream and should dispose it</param>
+        /// <exception cref="ArgumentNullException"></exception>
         protected Mp3FileReaderBase(Stream inputStream, FrameDecompressorBuilder frameDecompressorBuilder, bool ownInputStream)
         {
             if (inputStream == null) throw new ArgumentNullException(nameof(inputStream));

NAudio.Extras/AudioPlaybackEngine.cs

@@ -12,6 +12,9 @@ public class AudioPlaybackEngine : IDisposable
         private readonly IWavePlayer outputDevice;
         private readonly MixingSampleProvider mixer;
 
+        /// <summary>
+        /// Audio Playback Engine
+        /// </summary>
         public AudioPlaybackEngine(int sampleRate = 44100, int channelCount = 2)
         {
             outputDevice = new WaveOutEvent();
@@ -21,6 +24,9 @@ public AudioPlaybackEngine(int sampleRate = 44100, int channelCount = 2)
             outputDevice.Play();
         }
 
+        /// <summary>
+        /// Fire and forget playback of sound
+        /// </summary>
         public void PlaySound(string fileName)
         {
             var input = new AudioFileReader(fileName);
@@ -40,6 +46,9 @@ private ISampleProvider ConvertToRightChannelCount(ISampleProvider input)
             throw new NotImplementedException("Not yet implemented this channel count conversion");
         }
 
+        /// <summary>
+        /// Fire and forget playback of a cached sound
+        /// </summary>
         public void PlaySound(CachedSound sound)
         {
             AddMixerInput(new CachedSoundSampleProvider(sound));
@@ -50,6 +59,9 @@ private void AddMixerInput(ISampleProvider input)
             mixer.AddMixerInput(ConvertToRightChannelCount(input));
         }
 
+        /// <summary>
+        /// Disposes this instance
+        /// </summary>
         public void Dispose()
         {
             outputDevice.Dispose();

NAudio.Extras/AutoDisposeFileReader.cs

@@ -11,12 +11,19 @@ public class AutoDisposeFileReader : ISampleProvider
     {
         private readonly ISampleProvider reader;
         private bool isDisposed;
+
+        /// <summary>
+        /// Creates a new file reader that disposes the source reader when it finishes
+        /// </summary>
         public AutoDisposeFileReader(ISampleProvider reader)
         {
             this.reader = reader;
             WaveFormat = reader.WaveFormat;
         }
 
+        /// <summary>
+        /// Reads samples from this file reader
+        /// </summary>
         public int Read(float[] buffer, int offset, int count)
         {
             if (isDisposed)
@@ -33,6 +40,9 @@ public int Read(float[] buffer, int offset, int count)
             return read;
         }
 
+        /// <summary>
+        /// The WaveFormat of this file reader
+        /// </summary>
         public WaveFormat WaveFormat { get; }
     }
 }

NAudio.Extras/CachedSound.cs

@@ -9,8 +9,19 @@ namespace NAudio.Extras
     /// </summary>
     public class CachedSound
     {
+        /// <summary>
+        /// Audio data
+        /// </summary>
         public float[] AudioData { get; }
+
+        /// <summary>
+        /// Format of the audio
+        /// </summary>
         public WaveFormat WaveFormat { get; }
+
+        /// <summary>
+        /// Creates a new CachedSound from a file
+        /// </summary>
         public CachedSound(string audioFileName)
         {
             using (var audioFileReader = new AudioFileReader(audioFileName))

NAudio.Extras/Equalizer.cs

@@ -18,6 +18,9 @@ public class Equalizer : ISampleProvider
         private readonly int bandCount;
         private bool updated;
 
+        /// <summary>
+        /// Creates a new Equalizer
+        /// </summary>
         public Equalizer(ISampleProvider sourceProvider, EqualizerBand[] bands)
         {
             this.sourceProvider = sourceProvider;
@@ -43,14 +46,23 @@ private void CreateFilters()
             }
         }
 
+        /// <summary>
+        /// Update the equalizer settings
+        /// </summary>
         public void Update()
         {
             updated = true;
             CreateFilters();
         }
 
+        /// <summary>
+        /// Gets the WaveFormat of this Sample Provider
+        /// </summary>
         public WaveFormat WaveFormat => sourceProvider.WaveFormat;
 
+        /// <summary>
+        /// Reads samples from this Sample Provider
+        /// </summary>
         public int Read(float[] buffer, int offset, int count)
         {
             int samplesRead = sourceProvider.Read(buffer, offset, count);

NAudio.Extras/EqualizerBand.cs

@@ -1,9 +1,21 @@
 namespace NAudio.Extras
 {
+    /// <summary>
+    /// Equalizer Band
+    /// </summary>
     public class EqualizerBand
     {
+        /// <summary>
+        /// Frequency
+        /// </summary>
         public float Frequency { get; set; }
+        /// <summary>
+        /// Gain
+        /// </summary>
         public float Gain { get; set; }
+        /// <summary>
+        /// Bandwidth
+        /// </summary>
         public float Bandwidth { get; set; }
     }
 }

NAudio.Extras/NAudio.Extras.csproj

@@ -12,7 +12,7 @@
     <RepositoryUrl>https://github.com/naudio/NAudio</RepositoryUrl>
     <Copyright>© Mark Heath 2023</Copyright>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
-    <Version>2.2.1</Version>
+    <Version>2.2.1-SA</Version>
     <PackageIcon>naudio-icon.png</PackageIcon>
   </PropertyGroup>