Update unintelligibility algorithm

Signed-off-by: Dave Thaler <[email protected]>
orcasound · Jan 9, 2025 · 0fae460 · 0fae460
1 parent 114c7fa
commit 0fae460
Show file tree

Hide file tree

Showing 6 changed files with 62 additions and 7 deletions.
diff --git a/OrcanodeMonitor/Core/FfmpegCoreAnalyzer.cs b/OrcanodeMonitor/Core/FfmpegCoreAnalyzer.cs
@@ -99,8 +99,8 @@ public static double MinNoiseMagnitude
 
         // Minimum ratio of magnitude outside the hum range to magnitude
         // within the hum range.  So far the max in a known-unintelligible
-        // sample is 21% and the min in a known-good sample is 29%.
-        const double _defaultMinSignalPercent = 25;
+        // sample is 53% and the min in a known-good sample is 208%.
+        const double _defaultMinSignalPercent = 150;
         private static double MinSignalRatio
         {
             get
@@ -159,6 +159,50 @@ public double GetMaxNonHumMagnitude()
             return maxNonHumMagnitude;
         }
 
+        /// <summary>
+        /// Find the total magnitude outside the audio hum range.
+        /// </summary>
+        /// <returns>Magnitude</returns>
+        public double GetTotalNonHumMagnitude()
+        {
+            double totalNonHumMagnitude = 0;
+            foreach (var pair in FrequencyMagnitudes)
+            {
+                double frequency = pair.Key;
+                double magnitude = pair.Value;
+                if (!IsHumFrequency(frequency))
+                {
+                    if (magnitude > MinNoiseMagnitude)
+                    {
+                        totalNonHumMagnitude += magnitude;
+                    }
+                }
+            }
+            return totalNonHumMagnitude;
+        }
+
+        /// <summary>
+        /// Find the total magnitude of the audio hum range.
+        /// </summary>
+        /// <returns>Magnitude</returns>
+        public double GetTotalHumMagnitude()
+        {
+            double totalHumMagnitude = 0;
+            foreach (var pair in FrequencyMagnitudes)
+            {
+                double frequency = pair.Key;
+                double magnitude = pair.Value;
+                if (IsHumFrequency(frequency))
+                {
+                    if (magnitude > MinNoiseMagnitude)
+                    {
+                        totalHumMagnitude += magnitude;
+                    }
+                }
+            }
+            return totalHumMagnitude;
+        }
+
         private OrcanodeOnlineStatus GetStatus(OrcanodeOnlineStatus oldStatus)
         {
             double max = MaxMagnitude;
@@ -174,10 +218,12 @@ private OrcanodeOnlineStatus GetStatus(OrcanodeOnlineStatus oldStatus)
                 return oldStatus;
             }
 
-            // Find the maximum magnitude outside the audio hum range.
+            // Find the total magnitude outside the audio hum range.
             double maxNonHumMagnitude = GetMaxNonHumMagnitude();
+            double totalNonHumMagnitude = GetTotalNonHumMagnitude();
+            double totalHumMagnitude = GetTotalHumMagnitude();
 
-            if (maxNonHumMagnitude < MinNoiseMagnitude || maxNonHumMagnitude / max < MinSignalRatio)
+            if (maxNonHumMagnitude < MinNoiseMagnitude || totalNonHumMagnitude / totalHumMagnitude < MinSignalRatio)
             {
                 // Essentially just silence outside the hum range, no signal.
                 return OrcanodeOnlineStatus.Unintelligible;

diff --git a/OrcanodeMonitor/Pages/SpectralDensity.cshtml b/OrcanodeMonitor/Pages/SpectralDensity.cshtml
@@ -75,7 +75,9 @@
     <div>
         <h2>Statistics</h2>
         Max magnitude: @Model.MaxMagnitude<br />
-        Max magnitude outside hum range (50-60Hz): @Model.MaxNonHumMagnitude<br />
+        Max magnitude outside hum range: @Model.MaxNonHumMagnitude<br />
+        Total magnitude outside hum range: @Model.TotalNonHumMagnitude<br />
+        Total magnitude of hum range: @Model.TotalHumMagnitude<br />
         Signal ratio: @Model.SignalRatio%<br />
         Status: @Model.Status<br />
         <!-- Audio Button and Element -->

diff --git a/OrcanodeMonitor/Pages/SpectralDensity.cshtml.cs b/OrcanodeMonitor/Pages/SpectralDensity.cshtml.cs
@@ -26,6 +26,10 @@ public class SpectralDensityModel : PageModel
         public List<double> MaxBucketMagnitude => _maxBucketMagnitude;
         public string AudioUrl => _event?.Url ?? "Unknown";
         public int MaxMagnitude { get; private set; }
+        public int TotalNonHumMagnitude => (int)Math.Round(_totalNonHumMagnitude);
+        public int TotalHumMagnitude => (int)Math.Round(_totalHumMagnitude);
+        private double _totalHumMagnitude;
+        private double _totalNonHumMagnitude;
         public int MaxNonHumMagnitude { get; private set; }
         public int SignalRatio { get; private set; }
         public string Status { get; private set; }
@@ -81,8 +85,10 @@ private void UpdateFrequencyInfo(FrequencyInfo frequencyInfo)
             double maxNonHumMagnitude = frequencyInfo.GetMaxNonHumMagnitude();
             MaxMagnitude = (int)Math.Round(maxMagnitude);
             MaxNonHumMagnitude = (int)Math.Round(maxNonHumMagnitude);
-            SignalRatio = (int)Math.Round(100 * maxNonHumMagnitude / maxMagnitude);
             Status = Orcanode.GetStatusString(frequencyInfo.Status);
+            _totalHumMagnitude = frequencyInfo.GetTotalHumMagnitude();
+            _totalNonHumMagnitude = frequencyInfo.GetTotalNonHumMagnitude();
+            SignalRatio = (int)Math.Round(100 * _totalNonHumMagnitude / _totalHumMagnitude);
         }
 
         private async Task UpdateNodeFrequencyDataAsync()

diff --git a/Test/UnintelligibilityTests.cs b/Test/UnintelligibilityTests.cs
@@ -71,6 +71,7 @@ public async Task TestUnintelligibleSample()
         [TestMethod]
         public async Task TestNormalSample()
         {
+            await TestSampleAsync("normal\\live4118.ts", OrcanodeOnlineStatus.Online);
             await TestSampleAsync("normal\\live3368.ts", OrcanodeOnlineStatus.Online);
 
             await TestSampleAsync("normal\\live3504.ts", OrcanodeOnlineStatus.Online);

diff --git a/Test/samples/normal/live4118.ts b/Test/samples/normal/live4118.ts
diff --git a/docs/Design.md b/docs/Design.md
@@ -113,7 +113,7 @@ The following state will be stored per orcanode:
 
 **MEZMO_LOG_SECONDS**: The number of seconds of Mezmo logs to check for activity. Default: 60
 
-**ORCASOUND_MIN_INTELLIGIBLE_SIGNAL_PERCENT**: The minimum percentage of max amplitude across all frequencies of amplitude outside the 50-60 Hz range needed to determine that an audio stream is intelligible. Default: 30
+**ORCASOUND_MIN_INTELLIGIBLE_SIGNAL_PERCENT**: The minimum percentage of total magnitude across all frequencies outside the hum range vs magnitude in hum range, needed to determine that an audio stream is intelligible. Default: 150
 
 **ORCASOUND_MAX_SILENCE_AMPLITUDE**: The maximum amplitude at which an stream stream might still be considered unintelligible due to silence. Default: 20