Further refine chorus and reverb.

Author: Tkael

SpeechService/EddiSpeech.cs

@@ -11,13 +11,11 @@ public class EddiSpeech
         public string eventType { get; private set; }
 
         // Calculated SpeechFX data
-        public int echoDelay { get; set; }
-        public int chorusLevel { get; set; }
-        public int reverbLevel { get; set; }
-        public int distortionLevel { get; set; }
+        public int echoDelay { get; }
+        public int distortionLevel { get; }
 
         public EddiSpeech ( string message, string voice = null, int priority = 3,
-            string eventType = null, int configFxLevel = 0, LandingPadSize shipSize = null,
+            string eventType = null, LandingPadSize shipSize = null,
             decimal? shipHealth = 100M, bool radio = false, bool distortOnDamage = false )
         {
             this.message = message;
@@ -27,16 +25,8 @@ public EddiSpeech ( string message, string voice = null, int priority = 3,
             this.eventType = eventType;
 
             // Resolve the SpeechFX settings
-            this.echoDelay = GetEchoDelay( shipSize );
-            this.chorusLevel = GetChorusLevel( configFxLevel );
-            this.reverbLevel = GetReverbLevel( configFxLevel );
-            this.distortionLevel = GetDistortionLevel( distortOnDamage, shipHealth );
-        }
-
-        private static int GetChorusLevel ( int configFxLevel )
-        {
-            // This is not affected by ship parameters
-            return (int)( 60 * ( configFxLevel / 100M ) );
+            echoDelay = GetEchoDelay( shipSize );
+            distortionLevel = GetDistortionLevel( distortOnDamage, shipHealth );
         }
 
         private static int GetDistortionLevel ( bool distortOnDamage, decimal? shipHealth )
@@ -73,11 +63,5 @@ private static int GetEchoDelay ( LandingPadSize size )
 
             return echoDelayMs;
         }
-
-        private static int GetReverbLevel ( int configFxLevel )
-        {
-            // This is not affected by ship parameters
-            return (int)( 80 * ( configFxLevel / 100M ) );
-        }
     }
 }

SpeechService/SpeechEffects/SpeechFX.cs

@@ -12,9 +12,7 @@ namespace EddiSpeechService.SpeechEffects
 {
     public static class SpeechFX
     {
-        private static SpeechServiceConfiguration Configuration => SpeechService.Instance.Configuration;
-
-        public static IWaveProvider addEffectsToSource ( Stream stream, int chorusLevel, int reverbLevel, int echoDelay, int distortionLevel, bool radio )
+        public static IWaveProvider addEffectsToSource ( Stream stream, int targetVolume, int fxLevel, int distortionLevel, int echoDelay, bool radio )
         {
             using ( var source = new WaveFileReader( stream ) )
             {
@@ -32,12 +30,14 @@ public static IWaveProvider addEffectsToSource ( Stream stream, int chorusLevel,
 
                 var signal = new DiscreteSignal( source.WaveFormat.SampleRate, trimmedBuffer );
                 var sampleRate = source.WaveFormat.SampleRate;
-                var damageAdjustedFxLevel = FxParameters.DamageAdjustedFxLevel( distortionLevel, Configuration.EffectsLevel );
+                var damageAdjustedFxLevel = FxParameters.DamageAdjustedFxLevel( distortionLevel, fxLevel );
+
+                Logging.Debug( $"Effects level is {damageAdjustedFxLevel}, echo delay is {echoDelay}" );
 
-                Logging.Debug( $"Effects level is {damageAdjustedFxLevel}, chorus level is {chorusLevel}, reverb level is {reverbLevel}, echo delay is {echoDelay}" );
+                var resolvedReverbLevel = 0;
 
                 // Chorus - We always apply chorus effects.
-                signal = ApplyChorus(signal, chorusLevel, damageAdjustedFxLevel, sampleRate);
+                signal = ApplyChorus(signal, damageAdjustedFxLevel, sampleRate, out var resolvedChorusLevel);
 
                 // Radio (highpass)
                 if ( radio )
@@ -51,13 +51,13 @@ public static IWaveProvider addEffectsToSource ( Stream stream, int chorusLevel,
                     signal = ApplyEcho( signal, echoDelay, sampleRate );
 
                     // Reverb
-                    signal = ApplyReverb( signal, reverbLevel, damageAdjustedFxLevel, sampleRate );
+                    signal = ApplyReverb( signal, damageAdjustedFxLevel, sampleRate, out resolvedReverbLevel );
 
                     // Distortion (apply last)
                     signal = ApplyDamageDistortion( signal, distortionLevel );
                 }
 
-                signal = new DiscreteSignal( signal.SamplingRate, NormalizeSamples( signal ) );
+                signal = new DiscreteSignal( signal.SamplingRate, NormalizeSamples( signal, targetVolume ) );
 
                 // Generate the processed signal in mono
                 var processedSampleProvider = new DiscreteSignalSampleProvider( signal ).ToMono();
@@ -71,7 +71,7 @@ public static IWaveProvider addEffectsToSource ( Stream stream, int chorusLevel,
                 // Convert to 16-bit PCM (typical format for standard audio)
                 IWaveProvider waveProvider = new SampleToWaveProvider16( processedSampleProvider );
 
-                if ( chorusLevel != 0 || reverbLevel != 0 || echoDelay != 0 )
+                if ( resolvedChorusLevel != 0 || resolvedReverbLevel != 0 || echoDelay != 0 )
                 {
                     var extMs = Convert.ToInt32( 500 + Math.Max( 0, ( damageAdjustedFxLevel - 50 ) * 10 ) );
                     Logging.Debug( "Extending duration by " + extMs + "ms" );
@@ -82,12 +82,13 @@ public static IWaveProvider addEffectsToSource ( Stream stream, int chorusLevel,
             }
         }
 
-        private static DiscreteSignal ApplyChorus ( DiscreteSignal signal, int chorusLevel, int damageAdjustedFxLevel, int sampleRate )
+        private static DiscreteSignal ApplyChorus ( DiscreteSignal signal, int damageAdjustedFxLevel, int sampleRate, out int resolvedChorusLevel )
         {
-            if ( chorusLevel != 0 )
+            resolvedChorusLevel = (int)( 60 * ( damageAdjustedFxLevel / 100M ) );
+            if ( resolvedChorusLevel != 0 )
             {
-                var rate = Math.Max( 0.1f, chorusLevel / 20f ); // e.g., 1–5 Hz Frequency scaling
-                var width = Math.Max(0.005f, damageAdjustedFxLevel / 10f * .001f); // 5-10 ms delay
+                var rate = Math.Max( 0.1f, resolvedChorusLevel / 20f ); // e.g., 1–5 Hz Frequency scaling
+                var width = Math.Max(0.005f, resolvedChorusLevel / 10f * .001f); // 5-10 ms delay
 
                 var chorus = new ChorusEffect( sampleRate, new[] { rate }, new[] { width } );
                 chorus.WetDryMix( damageAdjustedFxLevel / 100f );
@@ -143,14 +144,15 @@ private static DiscreteSignal ApplyRadio (DiscreteSignal signal, int sampleRate)
             return signal;
         }
 
-        private static DiscreteSignal ApplyReverb ( DiscreteSignal signal, int reverbLevel, int damageAdjustedFxLevel, int sampleRate )
+        private static DiscreteSignal ApplyReverb ( DiscreteSignal signal, int damageAdjustedFxLevel, int sampleRate, out int resolvedReverbLevel )
         {
-            if ( reverbLevel != 0 )
+            resolvedReverbLevel = (int)( 80 * ( damageAdjustedFxLevel / 100M ) );
+            if ( resolvedReverbLevel != 0 )
             {
                 // Map reverbLevel to number of echoes and decay
-                var numEchoes = 1 + ( reverbLevel / 50 ); // 1 to 3 echoes
-                var baseDecay = 0.1f + ( 0.2f * ( reverbLevel / 100f ) ); // 0.1 to 0.3
-                var baseDelayMs = 30 + (int)( 120 * ( reverbLevel / 100f ) ); // 30ms to 150ms
+                var numEchoes = 1 + ( resolvedReverbLevel / 50 ); // 1 to 3 echoes
+                var baseDecay = 0.1f + ( 0.2f * ( resolvedReverbLevel / 100f ) ); // 0.1 to 0.3
+                var baseDelayMs = 30 + (int)( 120 * ( resolvedReverbLevel / 100f ) ); // 30ms to 150ms
 
                 for ( var i = 0; i < numEchoes; i++ )
                 {
@@ -166,7 +168,7 @@ private static DiscreteSignal ApplyReverb ( DiscreteSignal signal, int reverbLev
             return signal;
         }
 
-        private static float[] NormalizeSamples ( DiscreteSignal signal )
+        private static float[] NormalizeSamples ( DiscreteSignal signal, int targetVolume )
         {
             var samples = signal.Samples;
 
@@ -189,7 +191,7 @@ private static float[] NormalizeSamples ( DiscreteSignal signal )
                 }
             }
 
-            var volumeScale = Math.Max(0, Math.Min(100, Configuration.Volume)) / 100f;
+            var volumeScale = Math.Max(0, Math.Min(100, targetVolume)) / 100f;
             for ( var i = 0; i < samples.Length; i++ )
             {
                 // Apply configuration volume scaling (percent 0-100)

SpeechService/SpeechService.cs

@@ -225,8 +225,7 @@ public void Say(Ship ship, string message, int priority = 3, string voice = null
             if (string.IsNullOrEmpty(message)) { return; }
 
             // Queue the current speech
-            var queuingSpeech = new EddiSpeech( message, voice, priority, eventType, 
-                Configuration.EffectsLevel, ship?.Size, ship?.health, radio, Configuration.DistortOnDamage );
+            var queuingSpeech = new EddiSpeech( message, voice, priority, eventType, ship?.Size, ship?.health, radio, Configuration.DistortOnDamage );
             speechQueue.Enqueue( queuingSpeech );
 
             // Check the first item in the speech queue
@@ -298,12 +297,13 @@ internal bool checkSpeechInterrupt ( int peekedSpeechPriority )
             return false;
         }
 
-        public static void Speak(EddiSpeech speech)
+        public void Speak(EddiSpeech speech)
         {
-            Instance.Speak(speech.message, speech.voice, speech.echoDelay, speech.distortionLevel, speech.chorusLevel, speech.reverbLevel, speech.radio, speech.priority);
+            Instance.Speak(speech.message, speech.voice, Configuration.EffectsLevel, Configuration.Volume, speech.distortionLevel, speech.echoDelay, speech.priority, speech.radio );
         }
 
-        public void Speak(string speech, string defaultVoice, int echoDelay, int distortionLevel, int chorusLevel, int reverbLevel, bool radio = false, int priority = 3)
+        public void Speak ( string speech, string defaultVoice, int fxLevel, int volume = 95, 
+            int distortionLevel = 0, int echoDelay = 0, int priority = 3, bool radio = false )
         {
             if (speech == null || speech.Trim() == "") { return; }
 
@@ -314,19 +314,19 @@ public void Speak(string speech, string defaultVoice, int echoDelay, int distort
             }
 
             discardPendingSegments = false;
-            List<string> segments = SpeechFormatter.SeparateSpeechSegments(speech);
+            var segments = SpeechFormatter.SeparateSpeechSegments(speech);
 
-            foreach (string segment in segments)
+            foreach (var segment in segments)
             {
                 if ( discardPendingSegments )  { continue; }
 
                 string voice = null;
-                string statement = segment;
+                var statement = segment;
 
-                bool isAudio = segment.Contains("<audio"); // This is an audio file, we will disable voice effects processing
+                var isAudio = segment.Contains("<audio"); // This is an audio file, we will disable voice effects processing
                 if (isAudio)
                 {
-                    SpeechFormatter.UnpackAudioTags(segment, out string fileName, out bool async, out decimal? volumeOverride);
+                    SpeechFormatter.UnpackAudioTags(segment, out var fileName, out var async, out var volumeOverride);
                     try
                     {
                         // Play the audio, waiting for the audio to complete unless we're in async mode
@@ -355,21 +355,21 @@ public void Speak(string speech, string defaultVoice, int echoDelay, int distort
                     continue;
                 }
 
-                bool isRadio = statement.Contains("<transmit") || radio; 
+                var isRadio = statement.Contains("<transmit") || radio; 
                 if (isRadio)
                 {
                     // This is a radio transmission, we will enable radio voice effects processing
                     statement = SpeechFormatter.StripRadioTags( statement );
                 }
 
-                bool isVoice = statement.Contains("<voice"); 
+                var isVoice = statement.Contains("<voice"); 
                 if (isVoice)
                 {
                     // This is a voice override
                     SpeechFormatter.UnpackVoiceTags( statement, out voice, out statement );
                 }
 
-                using (Stream stream = getSpeechStream(voice ?? defaultVoice, statement))
+                using (var stream = getSpeechStream(voice ?? defaultVoice, statement))
                 {
                     if (stream == null)
                     {
@@ -388,14 +388,14 @@ public void Speak(string speech, string defaultVoice, int echoDelay, int distort
                     Logging.Debug("Seeking back to the beginning of the stream");
                     stream.Seek(0, SeekOrigin.Begin);
 
-                    var provider = SpeechFX.addEffectsToSource(stream, chorusLevel, reverbLevel, echoDelay, distortionLevel, isRadio);
+                    var provider = SpeechFX.addEffectsToSource(stream, volume, fxLevel, distortionLevel, echoDelay, isRadio );
                     PlaySpeechStreamAsync( provider, priority ).GetAwaiter().GetResult();
                 }
             }
         }
 
         // Obtain the speech memory stream
-        public Stream getSpeechStream ( string requestedVoice, string speech )
+        private Stream getSpeechStream ( string requestedVoice, string speech )
         {
             try
             {

Tests/SpeechTests.cs

@@ -29,7 +29,7 @@ public void start ()
         [DataRow( @"<phoneme alphabet=""ipa"" ph=""iˈlɛktrə"">Electra</phoneme>" )]
         public void TestPhonetics (string inputSpeech)
         {
-            SpeechService.Speak(new EddiSpeech(inputSpeech));
+            SpeechService.Instance.Speak(new EddiSpeech(inputSpeech));
         }
 
         [TestMethod, DoNotParallelize]
@@ -126,17 +126,8 @@ public void TestPowerplay ()
         [DataRow( 100 )]
         public void TestDamageDistortion (int shipHealth)
         {
-            var speech = new EddiSpeech( $"Systems at {shipHealth}%.", null, 0, null, 
-                50, LandingPadSize.Large, shipHealth, false, true );
-            SpeechService.Speak( speech );
-        }
-
-        [TestMethod, DoNotParallelize]
-        public void TestVariants ()
-        {
-            SpeechService.Instance.Say( ShipDefinitions.FromEDModel( "Vulture" ), "Welcome to your Vulture.  Weapons online." );
-            SpeechService.Instance.Say( ShipDefinitions.FromEDModel( "Python" ), "Welcome to your Python.  Scanning at full range." );
-            SpeechService.Instance.Say( ShipDefinitions.FromEDModel( "Anaconda" ), "Welcome to your Anaconda.  All systems operational." );
+            var speech = new EddiSpeech( $"Systems at {shipHealth}%.", null, 0, null, LandingPadSize.Large, shipHealth, false, true );
+            SpeechService.Instance.Speak( speech );
         }
 
         [DataTestMethod, DoNotParallelize]
@@ -146,17 +137,17 @@ public void TestVariants ()
         [DataRow( 60 )]
         [DataRow( 80 )]
         [DataRow( 100 )]
-        public void TestChorus ( int chorusLevel )
+        public void TestFxLevel ( int fxLevel )
         {
-            SpeechService.Instance.Speak( $"Chorus level {chorusLevel}", null, 0, 0, chorusLevel, 0, false, 0 );
+            SpeechService.Instance.Speak( $"Effects level {fxLevel}", null, fxLevel );
         }
 
         [DataTestMethod, DoNotParallelize]
         [DataRow( "Your python has touched down." )]
         [DataRow( "Anaconda golf foxtrot lima one niner six eight returning from orbit." )]
         public void TestRadio (string msg)
         {
-            SpeechService.Speak(new EddiSpeech(msg, radio: true));
+            SpeechService.Instance.Speak(new EddiSpeech(msg, radio: true));
         }
 
         [DataTestMethod, DoNotParallelize]
@@ -166,36 +157,14 @@ public void TestRadio (string msg)
         public void TestEchoDelay (int landingPadSize)
         {
             var shipSize = LandingPadSize.AllOfThem.First( s => s.sizeIndex == landingPadSize );
-            SpeechService.Speak( new EddiSpeech( $"Echo delay for a {shipSize} ship.", shipSize: shipSize ) );
-        }
-
-        [TestMethod, DoNotParallelize]
-        public void TestDropOff ()
-        {
-            var synth = new SpeechSynthesizer();
-            using ( var stream = new MemoryStream() )
-            {
-                synth.SetOutputToWaveStream( stream );
-                synth.Speak( "Testing drop-off." );
-                stream.Seek( 0, SeekOrigin.Begin );
-                var source = new WaveFileReader(stream);
-                var waitHandle = new EventWaitHandle(false, EventResetMode.AutoReset);
-                var soundOut = new WasapiOut();
-                soundOut.Init( source );
-                soundOut.PlaybackStopped += ( s, e ) => waitHandle.Set();
-                soundOut.Play();
-                waitHandle.WaitOne();
-                soundOut.Dispose();
-                source.Dispose();
-            }
-            SpeechService.Instance.Speak( "Testing drop-off.", null, 50, 1, 30, 40, true, 0 );
+            SpeechService.Instance.Speak( new EddiSpeech( $"Echo delay for a {shipSize} ship.", shipSize: shipSize ) );
         }
 
         [TestMethod, DoNotParallelize]
         public void TestSpeechNullInvalidVoice ()
         {
-            SpeechService.Speak( new EddiSpeech( "Testing null voice", null ) );
-            SpeechService.Speak( new EddiSpeech( "Testing non-valid voice", "No such voice" ) );
+            SpeechService.Instance.Speak( new EddiSpeech( "Testing null voice", null ) );
+            SpeechService.Instance.Speak( new EddiSpeech( "Testing non-valid voice", "No such voice" ) );
         }
     }
 }