Merge pull request #123 from nullinside-development-group/feat/skip

feat: adding skip all button

Author: ProgrammingByPermutation

src/TwitchStreamingTools/Configuration.cs

@@ -87,7 +87,10 @@ public static Configuration Instance {
   public bool SayUsernameWithMessage { get; set; }
 
   /// <inheritdoc />
-  public Keybind? SkipTtsKey { get; set; } = new() { Key = Keys.End };
+  public Keybind? SkipTtsKey { get; set; } = new() { Key = Keys.Pause };
+
+  /// <inheritdoc />
+  public Keybind? SkipAllTtsKey { get; set; }
 
   /// <summary>
   ///   Writes the configuration file to disk.

src/TwitchStreamingTools/Controls/ViewModels/Keybind.cs

@@ -1,4 +1,5 @@
-using System.Text;
+using System;
+using System.Text;
 
 using TwitchStreamingTools.Models;
 
@@ -52,4 +53,21 @@ public override string ToString() {
     sb.Append(Key);
     return sb.ToString();
   }
+
+  /// <inheritdoc />
+  public override bool Equals(object? obj) {
+    if (obj is Keybind keybind) {
+      return Key == keybind.Key &&
+             IsCtrl == keybind.IsCtrl &&
+             IsShift == keybind.IsShift &&
+             IsAlt == keybind.IsAlt;
+    }
+
+    return base.Equals(obj);
+  }
+
+  /// <inheritdoc />
+  public override int GetHashCode() {
+    return HashCode.Combine(Key, IsCtrl, IsShift, IsAlt);
+  }
 }

src/TwitchStreamingTools/IConfiguration.cs

@@ -56,6 +56,11 @@ public interface IConfiguration {
   /// </summary>
   Keybind? SkipTtsKey { get; set; }
 
+  /// <summary>
+  ///   The key press to skip all the TTS.
+  /// </summary>
+  Keybind? SkipAllTtsKey { get; set; }
+
   /// <summary>
   ///   Writes the configuration file to disk.
   /// </summary>

src/TwitchStreamingTools/Services/GlobalKeyPressService.cs

@@ -49,14 +49,14 @@ public class GlobalKeyPressService : IGlobalKeyPressService {
   ];
 
   /// <summary>
-  ///   The thread to execute on.
+  ///   The keystroke callback.
   /// </summary>
-  private readonly Thread _thread;
+  private static Action<Keybind>? s_onKeystroke;
 
   /// <summary>
-  ///   The keystroke callback.
+  ///   The thread to execute on.
   /// </summary>
-  private static Action<Keybind>? s_onKeystroke;
+  private readonly Thread _thread;
 
   /// <summary>
   ///   Initializes a new instance of the <see cref="GlobalKeyPressService" /> class.
@@ -130,8 +130,8 @@ private static int KeystrokeCallback(int nCode, IntPtr wParam, IntPtr lParam) {
       };
       LogKey(keybind);
 
-      var callbacks = s_onKeystroke;
-      foreach (var callback in callbacks?.GetInvocationList() ?? []) {
+      Action<Keybind>? callbacks = s_onKeystroke;
+      foreach (Delegate callback in callbacks?.GetInvocationList() ?? []) {
         try {
           callback.DynamicInvoke(keybind);
         }

src/TwitchStreamingTools/Services/TwitchTtsService.cs

@@ -85,21 +85,37 @@ public TwitchTtsService(ITwitchClientProxy twitchClientProxy, IConfiguration con
   /// <param name="keybind">The keystroke.</param>
   private void OnKeystroke(Keybind keybind) {
     Keybind? skip = _configuration.SkipTtsKey;
-    if (null == skip) {
-      return;
+    if (null != skip) {
+      if (keybind.Key == skip.Key &&
+          keybind.IsAlt == skip.IsAlt &&
+          keybind.IsCtrl == skip.IsCtrl &&
+          keybind.IsShift == skip.IsShift) {
+        List<TwitchChatTts> chats = _chats.ToList();
+        foreach (TwitchChatTts chat in chats) {
+          try {
+            chat.SkipCurrentTts();
+          }
+          catch {
+            // Do nothing, just try to skip the best we can.
+          }
+        }
+      }
     }
 
-    if (keybind.Key == skip.Key &&
-        keybind.IsAlt == skip.IsAlt &&
-        keybind.IsCtrl == skip.IsCtrl &&
-        keybind.IsShift == skip.IsShift) {
-      var chats = _chats.ToList();
-      foreach (TwitchChatTts chat in chats) {
-        try {
-          chat.SkipCurrentTts();
-        }
-        catch {
-          // Do nothing, just try to skip the best we can.
+    Keybind? skipAll = _configuration.SkipAllTtsKey;
+    if (null != skipAll) {
+      if (keybind.Key == skipAll.Key &&
+          keybind.IsAlt == skipAll.IsAlt &&
+          keybind.IsCtrl == skipAll.IsCtrl &&
+          keybind.IsShift == skipAll.IsShift) {
+        List<TwitchChatTts> chats = _chats.ToList();
+        foreach (TwitchChatTts chat in chats) {
+          try {
+            chat.SkipAllTts();
+          }
+          catch {
+            // Do nothing, just try to skip the best we can.
+          }
         }
       }
     }

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

@@ -72,6 +72,11 @@ public class SettingsViewModel : PageViewModelBase {
   /// </summary>
   private bool _showAdvancedTts;
 
+  /// <summary>
+  ///   The keybind for skipping all TTS messages.
+  /// </summary>
+  private KeybindViewModel _skipAllTtsKeyBinding;
+
   /// <summary>
   ///   The keybind for skipping TTS messages.
   /// </summary>
@@ -120,7 +125,8 @@ public class SettingsViewModel : PageViewModelBase {
   /// <param name="ttsPhoneticWordsViewModel">The view model for the phonetic words list.</param>
   /// <param name="ttsSkipUsernamesViewModel">The control responsible for managing the list of usernames to skip.</param>
   /// <param name="keybindViewModel">The skip TTS keybind.</param>
-  public SettingsViewModel(IConfiguration configuration, TtsPhoneticWordsViewModel ttsPhoneticWordsViewModel, TtsSkipUsernamesViewModel ttsSkipUsernamesViewModel, KeybindViewModel keybindViewModel) {
+  /// <param name="keybindAllViewModel">The skip all TTS keybind.</param>
+  public SettingsViewModel(IConfiguration configuration, TtsPhoneticWordsViewModel ttsPhoneticWordsViewModel, TtsSkipUsernamesViewModel ttsSkipUsernamesViewModel, KeybindViewModel keybindViewModel, KeybindViewModel keybindAllViewModel) {
     _configuration = configuration;
     _ttsPhoneticWordsViewModel = ttsPhoneticWordsViewModel;
     _ttsSkipUsernamesViewModel = ttsSkipUsernamesViewModel;
@@ -137,6 +143,9 @@ public SettingsViewModel(IConfiguration configuration, TtsPhoneticWordsViewModel
     _skipTtsKeyBinding = keybindViewModel;
     _skipTtsKeyBinding.Keybind = _configuration.SkipTtsKey;
     _skipTtsKeyBinding.Changed.Subscribe(OnSkipTtsKeybindChanged);
+    _skipAllTtsKeyBinding = keybindAllViewModel;
+    _skipAllTtsKeyBinding.Keybind = _configuration.SkipAllTtsKey;
+    _skipAllTtsKeyBinding.Changed.Subscribe(OnSkipAllTtsKeybindChanged);
 
     ToggleAdvancedTtsCommand = ReactiveCommand.Create(() => ShowAdvancedTts = !ShowAdvancedTts);
 
@@ -400,6 +409,14 @@ public KeybindViewModel SkipTtsKeyBinding {
     set => this.RaiseAndSetIfChanged(ref _skipTtsKeyBinding, value);
   }
 
+  /// <summary>
+  ///   The keybind to use to skip all TTS messages.
+  /// </summary>
+  public KeybindViewModel SkipAllTtsKeyBinding {
+    get => _skipAllTtsKeyBinding;
+    set => this.RaiseAndSetIfChanged(ref _skipAllTtsKeyBinding, value);
+  }
+
   /// <summary>
   ///   Handles updating the configuration when the skip TTS keybind changes.
   /// </summary>
@@ -412,4 +429,17 @@ private void OnSkipTtsKeybindChanged(IReactivePropertyChangedEventArgs<IReactive
     _configuration.SkipTtsKey = _skipTtsKeyBinding.Keybind;
     _configuration.WriteConfiguration();
   }
+
+  /// <summary>
+  ///   Handles updating the configuration when the skip all TTS keybind changes.
+  /// </summary>
+  /// <param name="args">The arguments about the properties that changed.</param>
+  private void OnSkipAllTtsKeybindChanged(IReactivePropertyChangedEventArgs<IReactiveObject> args) {
+    if (!nameof(_skipAllTtsKeyBinding.Keybind).Equals(args.PropertyName)) {
+      return;
+    }
+
+    _configuration.SkipAllTtsKey = _skipAllTtsKeyBinding.Keybind;
+    _configuration.WriteConfiguration();
+  }
 }

src/TwitchStreamingTools/Views/Pages/SettingsView/SettingsView.axaml

@@ -25,6 +25,7 @@
                 <RowDefinition Height="Auto" />
                 <RowDefinition Height="Auto" />
                 <RowDefinition Height="Auto" />
+                <RowDefinition Height="Auto" />
                 <RowDefinition />
             </Grid.RowDefinitions>
             <Grid.ColumnDefinitions>
@@ -44,33 +45,42 @@
                    Grid.Column="0"
                    HorizontalAlignment="Right"
                    VerticalAlignment="Center">
+                Skip All TTS Button:
+            </Label>
+            <controls:Keybind Grid.Row="1"
+                              Grid.Column="1"
+                              DataContext="{Binding SkipAllTtsKeyBinding}" />
+            <Label Grid.Row="2"
+                   Grid.Column="0"
+                   HorizontalAlignment="Right"
+                   VerticalAlignment="Center">
                 TTS Output Device:
             </Label>
-            <ComboBox Grid.Row="1"
+            <ComboBox Grid.Row="2"
                       Grid.Column="1"
                       HorizontalAlignment="Stretch"
                       VerticalAlignment="Center"
                       ItemsSource="{Binding OutputDevices}"
                       SelectedItem="{Binding SelectedOutputDevice}" />
-            <Label Grid.Row="2"
+            <Label Grid.Row="3"
                    Grid.Column="0"
                    HorizontalAlignment="Right"
                    VerticalAlignment="Center">
                 TTS Voice:
             </Label>
-            <ComboBox Grid.Row="2"
+            <ComboBox Grid.Row="3"
                       Grid.Column="1"
                       HorizontalAlignment="Stretch"
                       VerticalAlignment="Center"
                       ItemsSource="{Binding TtsVoices}"
                       SelectedItem="{Binding SelectedTtsVoice}" />
-            <Label Grid.Row="3"
+            <Label Grid.Row="4"
                    Grid.Column="0"
                    HorizontalAlignment="Right"
                    VerticalAlignment="Center">
                 TTS Volume:
             </Label>
-            <Grid Grid.Row="3"
+            <Grid Grid.Row="4"
                   Grid.Column="1">
                 <Grid.ColumnDefinitions>
                     <ColumnDefinition Width="Auto" />
@@ -89,14 +99,14 @@
                         IsSnapToTickEnabled="True"
                         Value="{Binding TtsVolume}" />
             </Grid>
-            <Label Grid.Row="4"
+            <Label Grid.Row="5"
                    Grid.Column="0"
                    HorizontalAlignment="Right"
                    VerticalAlignment="Top"
                    Margin="0 12 0 0">
                 TTS Playback Speed:
             </Label>
-            <Grid Grid.Row="4"
+            <Grid Grid.Row="5"
                   Grid.Column="1">
                 <Grid.ColumnDefinitions>
                     <ColumnDefinition Width="Auto" />
@@ -117,30 +127,30 @@
                         Maximum="3"
                         Value="{Binding Speed}" />
             </Grid>
-            <Label Grid.Row="5"
+            <Label Grid.Row="6"
                    Grid.Column="0"
                    HorizontalAlignment="Right"
                    VerticalAlignment="Top"
                    Margin="0 3 0 0">
                 Say Username with Message:
             </Label>
-            <CheckBox Grid.Row="5"
+            <CheckBox Grid.Row="6"
                       Grid.Column="1"
                       IsChecked="{Binding SayUsernameWithMessage}" />
-            <Label Grid.Row="6"
+            <Label Grid.Row="7"
                    Grid.Column="0"
                    HorizontalAlignment="Right"
                    VerticalAlignment="Top"
                    Margin="0 5 0 0">
                 Advanced TTS Playback:
             </Label>
-            <Button Grid.Row="6"
+            <Button Grid.Row="7"
                     Grid.Column="1"
                     IsVisible="{Binding !ShowAdvancedTts}"
                     Command="{Binding ToggleAdvancedTtsCommand}">
                 Show Options
             </Button>
-            <Grid Grid.Row="6"
+            <Grid Grid.Row="7"
                   Grid.Column="1"
                   IsVisible="{Binding ShowAdvancedTts}">
                 <Grid>
@@ -208,26 +218,26 @@
                               IsChecked="{Binding TurnOnSpeech}" />
                 </Grid>
             </Grid>
-            <Label Grid.Row="7"
+            <Label Grid.Row="8"
                    Grid.Column="0"
                    HorizontalAlignment="Right"
                    VerticalAlignment="Top"
                    Margin="0 5 0 0">
                 Skip User TTS:
             </Label>
-            <Grid Grid.Row="7"
+            <Grid Grid.Row="8"
                   Grid.Column="1">
                 <settingsView:TtsSkipUsernamesControl Margin="0,0,5,0"
                                                       DataContext="{Binding TtsSkipUsernamesViewModel}" />
             </Grid>
-            <Label Grid.Row="8"
+            <Label Grid.Row="9"
                    Grid.Column="0"
                    HorizontalAlignment="Right"
                    VerticalAlignment="Top"
                    Margin="0 5 0 0">
                 Phonetic Spellings:
             </Label>
-            <Grid Grid.Row="8"
+            <Grid Grid.Row="9"
                   Grid.Column="1">
                 <settingsView:TtsPhoneticWordsControl Margin="0,0,5,0"
                                                       DataContext="{Binding TtsPhoneticWordsViewModel}" />