feat: exposing underlying sound stretch variables

Exposing the variables for sound stretch so we can play with how things
sound before deciding on presets for the user.

closes #69

Author: ProgrammingByPermutation

src/TwitchStreamingTools/Configuration.cs

@@ -78,6 +78,11 @@ public static Configuration Instance {
   /// </summary>
   public IDictionary<string, string>? TtsPhonetics { get; set; }
 
+  /// <summary>
+  ///   The arguments to pass to Sound Stretcher to manipulate the TTS audio.
+  /// </summary>
+  public SoundStretchArgs? SoundStretchArgs { get; set; }
+
   /// <summary>
   ///   Writes the configuration file to disk.
   /// </summary>

src/TwitchStreamingTools/IConfiguration.cs

@@ -40,6 +40,11 @@ public interface IConfiguration {
   /// </summary>
   IDictionary<string, string>? TtsPhonetics { get; set; }
 
+  /// <summary>
+  ///   The arguments to pass to sound stretch to manipulate TTS audio.
+  /// </summary>
+  SoundStretchArgs? SoundStretchArgs { get; set; }
+
   /// <summary>
   ///   Writes the configuration file to disk.
   /// </summary>

src/TwitchStreamingTools/Models/SoundStretchArgs.cs

@@ -0,0 +1,41 @@
+namespace TwitchStreamingTools.Models;
+
+/// <summary>
+///   The arguments to pass to sound stretcher when manipulating TTS audio.
+/// </summary>
+public class SoundStretchArgs {
+  /// <summary>
+  ///   Change sound tempo by n percents (-95 to +5000 %)
+  /// </summary>
+  public int? Tempo { get; set; }
+
+  /// <summary>
+  ///   Change sound pitch by n semitones (-60 to +60 semitones)
+  /// </summary>
+  public int? Pitch { get; set; }
+
+  /// <summary>
+  ///   Change sound rate by n percents (-95 to +5000 %)
+  /// </summary>
+  public int? Rate { get; set; }
+
+  /// <summary>
+  ///   Detect the BPM rate of sound and adjust tempo to meet 'n' BPMs. If value not specified, just detects the BPM rate.
+  /// </summary>
+  public int? Bpm { get; set; }
+
+  /// <summary>
+  ///   Use quicker tempo change algorithm (gain speed, lose quality)
+  /// </summary>
+  public bool Quick { get; set; }
+
+  /// <summary>
+  ///   Don't use anti-alias filtering (gain speed, lose quality)
+  /// </summary>
+  public bool AntiAliasingOff { get; set; }
+
+  /// <summary>
+  ///   Tune algorithm for speech processing (default is for music)
+  /// </summary>
+  public bool TurnOnSpeech { get; set; }
+}

src/TwitchStreamingTools/Tts/TwitchChatTts.cs

@@ -3,6 +3,7 @@
 using System.Diagnostics;
 using System.IO;
 using System.Speech.Synthesis;
+using System.Text;
 using System.Threading;
 
 using NAudio.Wave;
@@ -233,7 +234,7 @@ private void PlaySoundsThread() {
   private void InitializeAndPlayTts(string sender, string chatMessage) {
     string filename = Path.GetTempFileName();
     string filename2 = Path.GetTempFileName();
-    
+
     try {
       string fileToPlay = filename;
 
@@ -255,7 +256,7 @@ private void InitializeAndPlayTts(string sender, string chatMessage) {
 
       var startInfo = new ProcessStartInfo {
         FileName = @"3rdParty\soundstretch.exe",
-        Arguments = $"\"{filename}\" \"{filename2}\" -tempo=+100 -speech",
+        Arguments = $"\"{filename}\" \"{filename2}\" {GetSoundStretcherArgs()}",
         UseShellExecute = false,
         CreateNoWindow = true
       };
@@ -364,4 +365,41 @@ private void Client_OnMessageReceived(OnMessageReceivedArgs e) {
       Console.WriteLine($"Failed to add: {e.ChatMessage.Username} says {e.ChatMessage.Message}\r\n{ex}");
     }
   }
+
+  /// <summary>
+  ///   Converts the configuration arguments to command line arguments for sound stretcher.
+  /// </summary>
+  /// <returns>The command line arguments.</returns>
+  private string GetSoundStretcherArgs() {
+    StringBuilder sb = new();
+    if (null != _configuration.SoundStretchArgs?.Tempo) {
+      sb.Append($" -tempo={(_configuration.SoundStretchArgs.Tempo > 0 ? "+" : "")}{_configuration.SoundStretchArgs.Tempo}");
+    }
+
+    if (null != _configuration.SoundStretchArgs?.Pitch) {
+      sb.Append($" -pitch={(_configuration.SoundStretchArgs.Pitch > 0 ? "+" : "")}{_configuration.SoundStretchArgs.Pitch}");
+    }
+
+    if (null != _configuration.SoundStretchArgs?.Rate) {
+      sb.Append($" -rate={(_configuration.SoundStretchArgs.Rate > 0 ? "+" : "")}{_configuration.SoundStretchArgs.Rate}");
+    }
+
+    if (null != _configuration.SoundStretchArgs?.Bpm) {
+      sb.Append($" -bpm={_configuration.SoundStretchArgs.Bpm}");
+    }
+
+    if (_configuration.SoundStretchArgs?.Quick ?? false) {
+      sb.Append(" -quick");
+    }
+
+    if (_configuration.SoundStretchArgs?.AntiAliasingOff ?? false) {
+      sb.Append(" -naa");
+    }
+
+    if (_configuration.SoundStretchArgs?.TurnOnSpeech ?? false) {
+      sb.Append(" -speech");
+    }
+
+    return sb.ToString().Trim();
+  }
 }

src/TwitchStreamingTools/ViewModels/Pages/SettingsView/SettingsViewModel.cs

@@ -19,11 +19,36 @@ public class SettingsViewModel : PageViewModelBase {
   /// </summary>
   private readonly IConfiguration _configuration;
 
+  /// <summary>
+  ///   Don't use anti-alias filtering (gain speed, lose quality)
+  /// </summary>
+  private bool _antiAliasingOff;
+
+  /// <summary>
+  ///   Detect the BPM rate of sound and adjust tempo to meet 'n' BPMs. If value not specified, just detects the BPM rate.
+  /// </summary>
+  private int _bpm;
+
   /// <summary>
   ///   The list of possible output devices that exist on the machine.
   /// </summary>
   private ObservableCollection<string> _outputDevices;
 
+  /// <summary>
+  ///   Change sound pitch by n semitones (-60 to +60 semitones)
+  /// </summary>
+  private int _pitch;
+
+  /// <summary>
+  ///   Use quicker tempo change algorithm (gain speed, lose quality)
+  /// </summary>
+  private bool _quick;
+
+  /// <summary>
+  ///   Change sound rate by n percents (-95 to +5000 %)
+  /// </summary>
+  private int _rate;
+
   /// <summary>
   ///   The selected output device to send TTS to.
   /// </summary>
@@ -34,6 +59,11 @@ public class SettingsViewModel : PageViewModelBase {
   /// </summary>
   private string? _selectedTtsVoice;
 
+  /// <summary>
+  ///   Change sound tempo by n percents (-95 to +5000 %)
+  /// </summary>
+  private int _tempo;
+
   /// <summary>
   ///   The view model for the phonetic words list.
   /// </summary>
@@ -55,13 +85,19 @@ public class SettingsViewModel : PageViewModelBase {
   /// <remarks>0 is silent, 100 is full volume.</remarks>
   private uint _ttsVolume;
 
+  /// <summary>
+  ///   Tune algorithm for speech processing (default is for music)
+  /// </summary>
+  private bool _turnOnSpeech;
+
   /// <summary>
   ///   Initializes a new instance of the <see cref="SettingsViewModel" /> class.
   /// </summary>
   public SettingsViewModel(IConfiguration configuration, TtsPhoneticWordsViewModel ttsPhoneticWordsViewModel, TtsSkipUsernamesViewModel ttsSkipUsernamesViewModel) {
     _configuration = configuration;
     _ttsPhoneticWordsViewModel = ttsPhoneticWordsViewModel;
     _ttsSkipUsernamesViewModel = ttsSkipUsernamesViewModel;
+    _configuration.SoundStretchArgs ??= new SoundStretchArgs();
 
     // Get the list of output devices and set the default to either what we have in the configuration or the system 
     // default whichever is more appropriate.
@@ -171,4 +207,102 @@ public TtsSkipUsernamesViewModel TtsSkipUsernamesViewModel {
     get => _ttsSkipUsernamesViewModel;
     set => this.RaiseAndSetIfChanged(ref _ttsSkipUsernamesViewModel, value);
   }
+
+  /// <summary>
+  ///   Change sound tempo by n percents (-95 to +5000 %)
+  /// </summary>
+  public int Tempo {
+    get => _tempo;
+    set {
+      this.RaiseAndSetIfChanged(ref _tempo, value);
+      if (_configuration.SoundStretchArgs != null) {
+        _configuration.SoundStretchArgs.Tempo = value;
+        _configuration.WriteConfiguration();
+      }
+    }
+  }
+
+  /// <summary>
+  ///   Change sound pitch by n semitones (-60 to +60 semitones)
+  /// </summary>
+  public int Pitch {
+    get => _pitch;
+    set {
+      this.RaiseAndSetIfChanged(ref _pitch, value);
+      if (_configuration.SoundStretchArgs != null) {
+        _configuration.SoundStretchArgs.Pitch = value;
+        _configuration.WriteConfiguration();
+      }
+    }
+  }
+
+  /// <summary>
+  ///   Change sound rate by n percents (-95 to +5000 %)
+  /// </summary>
+  public int Rate {
+    get => _rate;
+    set {
+      this.RaiseAndSetIfChanged(ref _rate, value);
+      if (_configuration.SoundStretchArgs != null) {
+        _configuration.SoundStretchArgs.Rate = value;
+        _configuration.WriteConfiguration();
+      }
+    }
+  }
+
+  /// <summary>
+  ///   Detect the BPM rate of sound and adjust tempo to meet 'n' BPMs. If value not specified, just detects the BPM rate.
+  /// </summary>
+  public int Bpm {
+    get => _bpm;
+    set {
+      this.RaiseAndSetIfChanged(ref _bpm, value);
+      if (_configuration.SoundStretchArgs != null) {
+        _configuration.SoundStretchArgs.Bpm = value;
+        _configuration.WriteConfiguration();
+      }
+    }
+  }
+
+  /// <summary>
+  ///   Use quicker tempo change algorithm (gain speed, lose quality)
+  /// </summary>
+  public bool Quick {
+    get => _quick;
+    set {
+      this.RaiseAndSetIfChanged(ref _quick, value);
+      if (_configuration.SoundStretchArgs != null) {
+        _configuration.SoundStretchArgs.Quick = value;
+        _configuration.WriteConfiguration();
+      }
+    }
+  }
+
+  /// <summary>
+  ///   Don't use anti-alias filtering (gain speed, lose quality)
+  /// </summary>
+  public bool AntiAliasingOff {
+    get => _antiAliasingOff;
+    set {
+      this.RaiseAndSetIfChanged(ref _antiAliasingOff, value);
+      if (_configuration.SoundStretchArgs != null) {
+        _configuration.SoundStretchArgs.AntiAliasingOff = value;
+        _configuration.WriteConfiguration();
+      }
+    }
+  }
+
+  /// <summary>
+  ///   Tune algorithm for speech processing (default is for music)
+  /// </summary>
+  public bool TurnOnSpeech {
+    get => _turnOnSpeech;
+    set {
+      this.RaiseAndSetIfChanged(ref _turnOnSpeech, value);
+      if (_configuration.SoundStretchArgs != null) {
+        _configuration.SoundStretchArgs.TurnOnSpeech = value;
+        _configuration.WriteConfiguration();
+      }
+    }
+  }
 }

src/TwitchStreamingTools/ViewModels/Pages/SettingsView/TtsSkipUsernamesViewModel.cs

@@ -134,7 +134,7 @@ private async void UserListRefreshTimer_OnElapsed(object sender, ElapsedEventArg
 
       var usernames = new HashSet<string>();
       foreach (TwitchChatConfiguration chat in _configuration.TwitchChats ?? []) {
-        if (string.IsNullOrWhiteSpace(chat.TwitchChannel)) {
+        if (string.IsNullOrWhiteSpace(chat.TwitchChannel) || _doNotScanChat.Contains(chat.TwitchChannel)) {
           continue;
         }
 

src/TwitchStreamingTools/Views/MainWindow.axaml.cs

@@ -11,6 +11,7 @@
 using Avalonia.Threading;
 
 using TwitchStreamingTools.ViewModels;
+
 #else
 using Avalonia;
 #endif