Skip to content

Latest commit

 

History

History
332 lines (310 loc) · 17 KB

CHANGELOG.md

File metadata and controls

332 lines (310 loc) · 17 KB

v1.8.0.1

  • Fixed an oversight where audio streams could not properly parse certain .wav files due to unexpected metadata

v1.8

Summary:

  • Many bug fixes
  • Complete overhaul of the sound filter system
    • Filters are now applied through instances rather than only the singleton from registering the filter to FilterLoader
    • Filter parameter fading from SoLoud is now properly implemented
    • Methods for loading SoundEffects and StreamPackages now have overloads that accept SoLoudFilterInstance objects
    • Previously hidden classes for filters are now public
  • Improved the performance and API of FormatWav and WavSample
  • The Echo and Reverb filters can now be applied to audio streams
  • Added builtin support for generating Fast Fourier Transform (FFT) graphs from audio streams

Fixes:

  • Reduced allocations from StreamManager by caching the IEnumerator<T> object
  • Fixed FormatWav not implementing the IDisposable interface correctly
  • Fixed a few oversights that resulted in only .ogg files being streamable
  • Fixed the Freeverb filter not processing the Right speaker for whatever reason (I had commented out the code for it???)
  • Fixed the Freeverb filter not getting an extra sample buffer when filtering a sound file, unlike how the Echo filter is handled
  • Fixed sound streams completely stopping if a filter threw an exception

New Types:

  • class BiquadResonantFilter, class BiquadResonantFilterInstance
    • Represents a biquad resonant filter, i.e. Low Pass, High Pass and Band Pass
    • Parameters:
      • float paramStrength (inherited)
      • int paramType
      • float paramFrequency
      • float paramResonance
    • Read Sound Filtering | Biquad Resonant for more info
  • struct ConstrainedValue<T>
    • A structure that automatically constricts a value between a minimum and maximum value
    • Used by filter parameters
  • class DynamicStreamPackage
    • An empty, customizable StreamPackage
    • Events:
      • event Action<DynamicStreamPackage> OnReset
      • event DynamicStreamPackage.ModifySamplesDelegate OnSamplesRead
      • event DynamicStreamPackage.ModifyReadSecondsDelegate OnModifyReadSeconds
      • event DynamicStreamPackage.ModifyByteSamplesDelegate OnPreSubmitByteBuffer
      • event DynamicStreamPackage.ModifyWaveSamplesDelegate OnPreSubmitWaveBuffer
    • Methods:
      • virtual byte[] ReadSamples(double)
  • class EchoFilter, class EchoFilterInstance
    • Represents an echo filter
    • Parameters:
      • float paramStrength (inherited)
      • float paramDelay
      • float paramDecay
      • float paramBias
    • Read Sound Filtering | Echo for more info
  • class FastFourierTransform
    • A class used to generate Fast Fourier Transform (FFT) graphs from audio streams
    • Check /MonoSound.Tests/Game1.cs for an example of rendering an FFT graph
    • Methods:
      • void Process(float[])
        • Begins a query of the FFT graph for the provided audio sample data
      • void SetGraphToStaticRenderMode()
        • Sets the graph to render the same data every frame until Process(float[]) is called again
      • void SetGraphToDecayRenderMode(double)
        • Sets the graph to render the data with a decay-over-time effect, where the values decrease by the provided factor every frame
      • IEnuemrable<FFTGraphPoint> QueryRMSGraph()
        • Returns an enumeration of FFT graph points representing the Root Mean Square (RMS) values of the audio data, i.e. the raw FFT results from the query
      • IEnumerable<FFTGraphPoint> QueryDBGraph()
        • Returns an enumeration of FFT graph points representing the Decibel (dB) values of the audio data
  • struct FFTGraphPoint
    • Represents a point on an FFT graph
    • Members:
      • double Frequency
      • double Value
  • class FreeverbFilter, class FreeverbFilterInstance
    • Represents a filter using the Freeverb algorithm
    • Parameters:
      • float paramStrength (inherited)
      • bool paramFrozen
      • float paramFeedback
      • float paramDampness
      • float paramStereoWidth
    • Read Sound Filtering | Reverb for more info
  • class SoLoudFader<T>
    • A class attached to filter parameters for fading from one value to another over time
  • class SoLoudFilter
    • Base class for all filters
    • Reponsible for a global singleton and creating new filter instances
  • class SoLoudFilter.Parameter, class SoLoudFilter.Parameter<T>, class SoLoudFilter.BoolParameter
    • Represents a parameter for a filter instance
    • Can be created via the CreateParameter<T>(T, T, T) and CreateParameter(bool) method in SoLoudFilterInstance
  • class SoLoudFilterInstance
    • Base class for all filter instances
    • Contains the parameters for the filter
    • Responsible for modifying the sample data
    • Parameters:
      • float paramStrength
  • struct PCM16Bit, struct PCM24Bit
    • Structures used by WavSample to store 16-bit and 24-bit PCM sample data
    • Aligned to int size
  • class PcmFormat, class PcmStream
    • Used to handle reading/streaming from .pcm files
    • Automatically registered, but requires a PcmFormatSettings object to be loaded or streamed

API Changes:

  • CustomAudioFormat
    • New members:
      • FormatWav ReadWav(string, object)
      • FormatWav ReadWav(Stream, object)
  • EffectLoader
    • New members:
      • SoundEffect GetBankFilteredEffect(string, string, string, SoLoudFilterInstance)
      • SoundEffect GetBankFilteredEffect(Stream, string, Stream, string, string, SoLoudFilterInstance)
      • SoundEffect GetBankMultiFilteredEffect(string, string, string, params SoLoudFilterInstance[])
      • SoundEffect GetBankMultiFilteredEffect(Stream, string, Stream, string, string, params SoLoudFilterInstance[])
      • SoundEffect GetEffect(string, CustomAudioFormat, object)
      • SoundEffect GetEffect(Stream, CustomAudioFormat, object)
      • SoundEffect GetFilteredEffect(string, CustomAudioFormat, object, int)
      • SoundEffect GetFilteredEffect(string, CustomAudioFormat, object, SoLoudFilterInstance)
      • SoundEffect GetFilteredEffect(Stream, CustomAudioFormat, object, string, int)
      • SoundEffect GetFilteredEffect(Stream, CustomAudioFormat, object, string, SoLoudFilterInstance)
      • SoundEffect GetMultiFilteredEffect(string, CustomAudioFormat, object, params int[])
      • SoundEffect GetMultiFilteredEffect(string, CustomAudioFormat, object, params SoLoudFilterInstance[])
      • SoundEffect GetMultiFilteredEffect(Stream, CustomAudioFormat, object, string, params int[])
      • SoundEffect GetMultiFilteredEffect(Stream, CustomAudioFormat, object, string, params SoLoudFilterInstance[])
  • FilterLoader
    • New members:
      • int RegisterFilter(SoLoudFilter)
      • SoLoudFilter GetRegisteredFilter(int)
      • BiquadResonantFilterInstance GetBiquadResonantFilterSingleton(int)
      • EchoFilterInstance GetEchoFilterSingleton(int)
      • FreeverbFilterInstance GetReverbFilterSingleton(int)
    • Changed members:
      • The parameters for most of the methods were renamed to fit the constructors of the new SoLoudFilter-deriving types
    • Obsolete members:
      • void UpdateBiquadResonantFilter(int, SoundFilterType?, float?, float?, float?)
      • void UpdateEchoFilter(int, float?, float?, float?, float?)
      • void UpdateReverbFilter(int, float?, float?, float?, float?)
  • FormatWav
    • Removed members:
      • byte[] Data { get; }
    • New members:
      • static FormatWav FromSampleDataAndSettings(WavSample[], AudioChannels, int, int)
  • MonoSoundLibrary
    • New members:
      • const string VersionLiteral
    • Obsolete members:
      • void SetFilterMaxCount(int)
      • void ClearFilters()
  • StreamedSoundEffectInstance
    • Class is now public
  • StreamPackage
    • StreamedSoundEffectInstance PlayingSound { get; } is now public
    • void InitSound() is now protected
    • 24-bit PCM sample data is now supported
    • New members:
      • struct SubmitBufferControls
        • Interface for setting hidden controls used while queuing and submitting audio data buffers
      • void ApplyFilters(params SoLoudFilterInstance[])
        • Alternative for applying instances directly
        • Provided instances cannot be a filter singleton
      • SoLoudFilterInstance GetFilterInstance(int)
        • Returns the first filter instance whose parent's ID matches the provided filter ID or null if no filter instance is found
      • ReadOnlySpan<SoLoudFilterInstance> GetFilterInstances()
        • Returns a read-only collection of the currently active filter instances
      • void PreQueueBuffers(ref StreamPackage.SubmitBufferControls)
      • void PreSubmitBuffer(ref byte[])
        • Called when PreQueueBuffers() sets controls.requestPCMSamplesForEvent = false;
      • void PreSubmitBuffer(ref WavSample[])
        • Called when PreQueueBuffers() sets controls.requestPCMSamplesForEvent = true;
      • void RemoveAllFilters()
        • Removes all filter instances currently applied to the stream
      • FastFourierTransform FFT { get; }
        • The currently active FFT graph for the stream, or null if there is none
      • FastFourierTransform BeginTrackingFFT()
        • Begins tracking the FFT graph for the stream
        • Returns the FFT graph object
      • void StopTrackingFFT()
        • Stops tracking the FFT graph for the stream
  • WavSample
    • Internal structure has been completely reworked to be more efficient and easier to work with
    • Removed members:
      • WavSample..ctor(short, data[])
    • New members:
      • WavSample..ctor(PCM16Bit)
      • WavSample..ctor(PCM24Bit)
      • WavSample..ctor(byte[])
      • WavSample..ctor(ReadOnlySpan<byte>)
      • int SampleSize { get; }
      • PCM16Bit Sample16Bit { get; set; }
      • PCM24Bit Sample24Bit { get; set; }
      • static byte[] ToByteArray(WavSample[])
    • Replaced members:
      • short SampleSize with int SampleSize { get; }
      • byte[] Data { get; set; } with PCM16Bit Sample16Bit { get; set; } and PCM24Bit Sample24Bit { get; set; }

Miscellaneous:

  • Updated the library to .NET 8.0
  • Added missing XML summaries

v1.7.1.1

Fixes:

  • Added an exception handler to audio stream loading to prevent the worker thread from stopping if an exception is thrown
  • Fixed an oversight where MonoSoundLibrary.DeInit() would softlock

v1.7.1

Fixes:

  • Implemented a hopefully temporary fix for a bug where streamed audio would randomly have the wrong pitch or volume
  • Moved audio streaming to a worker thread and an internal SoundEffectInstance-deriving type to fix audio popping at lower framerates

API Changes:

  • Removed the internal FastReflection class and its related classes in favor of an assembly publicizer package
  • MonoSoundLibrary
    • Obsolete members:
      • void Init()
        • Replacement: void Init(Game)
        • MonoSoundLibrary now has to track the Game it's assigned to for some new API features
  • Controls
    • New properties:
      • StreamFocusBehavior DefaultStreamFocusBehavior { get; set; }
        • Controls the default behavior for StreamPackages when the game is not focused
        • Defaults to StreamFocusBehavior.KeepPlaying
  • StreamPackage
    • New methods:
      • void Resume()
        • Previously missing method for mirroring of SoundEffectInstance handling
        • Pauses the stream
    • New properties:
      • StreamFocusBehavior? FocusBehavior { get; set; }
        • Acts as an override of Controls.DefaultStreamFocusBehavior
        • Defaults to null, which is interpreted as using the value of Controls.DefaultStreamFocusBehavior

v1.7

Fixes:

  • Fixed a copy/paste typo which caused the RegisterBiquadResonantFilter, RegisterEchoFilter and RegisterReverbFilter methods in MonoSoundManager to mention the wrong methods
  • Fixed a bug where the additional samples created by the Echo filter would not be played
  • Fixed a bug where StreamPackage would fail to loop due to a null-reference error

API Changes:

  • Controls.StreamBufferLengthInSeconds now defaults to 0.01 instead of 0.1
  • StreamPackage
    • New methods:
      • void ClearAudioQueue()
      • double GetSecondDuration(long)
      • long ModifyResetOffset(long)
      • void OnLooping()
      • void Pause()
      • void Play()
      • void SetStreamPosition(double)
      • void Stop()
    • New properties:
      • TimeSpan CurrentDuration { get; }
      • TimeSpan MaxDuration { get; }
      • TimeSpan ReadTime { get; }
      • SoundMetrics metrics { get; }
    • Obsolete members:
      • override void ChildDispose(bool)
        • Replacement: override void Dispose(bool)
    • Member changes:
      • int ReadBytes ⇒ long ReadBytes
      • int TotalBytes ⇒ long TotalBytes
      • The setters for ReadBytes and SecondsRead are now protected
      • The setter for IsLooping is now public
      • The void HandleLooping() method is now virtual protected
      • The PlayingSound property is now internal
  • OggStream
    • vorbisStream is now protected
    • vorbisReadStart ⇒ loopTargetTime
    • loopTargetTime is now protected
  • Filter
    • Now contains a bool RequiresSampleMemory property which is used to prevent the filter from being used by certain APIs
  • EffectLoader and SteamLoader have new methods for handling custom audio formats
  • Added MonoSound.Default.SegmentedOggFormat
    • Example use case for CustomAudioFormat
    • This type should not be registered. Instead, create a new SegmentedOggFormat() and pass it to the StreamLoader methods that accept a CustomAudioFormat parameter
    • Streams created from this format use the MonoSound.Default.SegmentedOggStream type
    • Example usage can be found in the MonoSound.Tests project
  • Added methods in FilterLoader for updating the parameters on an already-existing filters

Obsolete API:

  • CustomFileFormat ⇒ CustomAudioFormat
  • MonoSoundLibrary.RegisterFormat(string, Func<Stream, FormatWav>, Func<Stream, StreamPackage>) ⇒ MonoSoundLibrary.RegisterFormat(CustomAudioFormat)

v1.6.2

  • Replaced all usage of File.OpenRead() with TitleContainer.OpenStream(), since the former prevented MonoSound from loading on Android projects

v1.6.1

  • Fixed an issue where filters on a streamed sound would have noise

v1.6.0.0

  • Modified the API to be more user-friendly and sensible
  • Made the following classes public: StreamPackage, WavStream, XnbStream, Mp3Stream, OggStream, WavebankStream
  • Fixed an issue that causes sound streaming to not work as intended
  • Added an API for reading sound files in custom formats via MonoSoundLibrary.RegisterFormat()
  • Improved the logic responsible for caching loaded wavebanks
  • Fixed some bugs in the streaming logic which caused looping XWB sounds to sometimes fail
  • Added logic to allow streamed sounds to have effects applied to them dynamically
  • Added a control for specifying the length of the buffers read for streamed sounds. Defaults to 0.1 seconds.
  • Added proper safeguards to Filter object freeing in order to prevent some nasty CLR crashes
  • Added a safeguard for MP3Sharp audio loading

v1.5.2.0

  • Made the MonoSound.Audio.FormatWav class public
  • WAVE data with metadata can now be loaded by MonoSound

v1.5.1.0

  • Added support for loading SoundEffect instances from XACT wavebank streams (overload was missing)

v1.5.0.0

  • Added support for loading SoundEffect instances from System.IO.Stream instances
  • Added support for applying sound filters to System.IO.Stream instances

v1.4.0.0

  • Added support for streaming from MPEG Audio Layer III (.mp3) files
  • Added support for creating SoundEffect instances directly from the supported audio file types (.xnb, .wav, .ogg and .mp3)

v1.3.0.0

  • Added support for streaming from OGG Vorbis (.ogg) sound files

v1.2.0.0

  • Added support for sounds located in XACT sound and wave banks
    • Dislaimer: any looping data stored in the sounds is effectively removed. Looping sounds will have to be set manually in code via SoundEffectInstance.IsLooped
  • Added a sub-manager for streaming sound effects from compiled XNB files and XACT wave banks.
    • Disclaimer: streamed sounds cannot have filters applied to them.

v1.1.0.0

  • Implemented the Freeverb (Reverb) and Echo sound filters from SoLoud
  • Sound files can now be passed through multiple filters at once
  • OGG Vorbis file format support (.ogg) via NVorbis
  • MonoSoundManager contains a new property, AllowEchoOversampling, which controls whether the Echo filter is allowed to extend the original sound by over 30 seconds
  • MonoSound can now write the sampled sound to a file. Set the MonoSoundManager.LogDirectory property to the directory where the sounds will be saved to and set MonoSoundManager.LogFilters to true to enable saving to files

v1.0.0.0

  • First official release