Merge pull request #142 from nullinside-development-group/feat/voices

feat: updating code to see all voices installed on system

Author: ProgrammingByPermutation

.github/workflows/codeql.yml

@@ -36,7 +36,7 @@ jobs:
       - name: Install .NET Core
         uses: actions/setup-dotnet@v3
         with:
-          dotnet-version: 9.x.x
+          dotnet-version: 10.x.x
 
       # Execute the build
       - name: Execute Release Build
@@ -58,7 +58,7 @@ jobs:
       - name: Install .NET Core
         uses: actions/setup-dotnet@v3
         with:
-          dotnet-version: 9.x.x
+          dotnet-version: 10.x.x
 
       # Execute the tests
       - name: Execute Tests
@@ -120,7 +120,7 @@ jobs:
       - name: Install .NET Core
         uses: actions/setup-dotnet@v3
         with:
-          dotnet-version: 9.x.x
+          dotnet-version: 10.x.x
 
       # Execute the build
       - name: Execute Build

Dockerfile

@@ -1,8 +1,8 @@
-FROM mcr.microsoft.com/dotnet/aspnet:9.0 AS base
+FROM mcr.microsoft.com/dotnet/aspnet:10.0 AS base
 USER $APP_UID
 WORKDIR /app
 
-FROM mcr.microsoft.com/dotnet/sdk:9.0 AS build
+FROM mcr.microsoft.com/dotnet/sdk:10.0 AS build
 ARG BUILD_CONFIGURATION=Release
 ARG TAG_VERSION
 WORKDIR /src

README.md

@@ -2,6 +2,32 @@
 
 Tools to aid twitch streamers.
 
+## To Install Additional Voices
+
+To install additional voices you need to install the language in Windows 11:
+1. Open the start menu and search for `Language Settings`
+
+![The language settings menu](assets/images/language-settings.png)
+
+2. In the "Preferred languages" row, click "Add a language"
+
+![Add a language button](assets/images/add-a-language.png)
+
+3. In the "Choose a language to install" dialog, select the language with "Text-to-speech" icon.
+   * **Note:** Only items with the text-to-speech icon will show up in the application once installed.
+
+![Choose language dialog](assets/images/choose-language.png)
+
+4. In the "Install language features" dialog, you only need to install the "Text-to-speech" for the language and click install. 
+   * **Note:** All other boxes may be **unchecked**.
+
+![Install language features dialog](assets/images/install-language-features.png)
+
+Once installed (it may take some time), restart the application and they should be displayed in the settings menu under
+TTS Voices.
+
+![TTS settings](assets/images/tts-voices.png)
+
 ## Design
 
 ### Account Management

assets/images/add-a-language.png

@@ -1,7 +1,7 @@
 <Project Sdk="Microsoft.NET.Sdk">
     <PropertyGroup>
         <OutputType>WinExe</OutputType>
-        <TargetFramework>net9.0</TargetFramework>
+        <TargetFramework>net10.0</TargetFramework>
         <Nullable>enable</Nullable>
         <BuiltInComInteropSupport>true</BuiltInComInteropSupport>
         <ApplicationManifest>app.manifest</ApplicationManifest>
@@ -64,11 +64,11 @@
         <PackageReference Include="CommunityToolkit.Mvvm" Version="8.4.0"/>
         <PackageReference Include="DynamicData" Version="9.4.1"/>
         <PackageReference Include="log4net" Version="3.2.0"/>
-        <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="9.0.10" />
+        <PackageReference Include="Microsoft.Extensions.DependencyInjection" Version="10.0.0" />
         <PackageReference Include="NAudio.Wasapi" Version="2.2.1"/>
         <PackageReference Include="NAudio.WinMM" Version="2.2.1"/>
         <PackageReference Include="PInvoke.User32" Version="0.7.124"/>
-        <PackageReference Include="System.Speech" Version="9.0.10" />
+        <PackageReference Include="System.Speech" Version="10.0.0" />
     </ItemGroup>
 
     <ItemGroup>

assets/images/choose-language.png

@@ -164,8 +164,7 @@ public SettingsViewModel(IConfiguration configuration, TtsPhoneticWordsViewModel
 
     // Get the list of TTS voices and set the default to either what we have in the configuration or the system 
     // default whichever is more appropriate.
-    using var speech = new SpeechSynthesizer();
-    _ttsVoices = new ObservableCollection<string>(speech.GetInstalledVoices().Select(v => v.VoiceInfo.Name));
+    _ttsVoices = new ObservableCollection<string>(GetFilteredTtsVoices());
     _selectedTtsVoice = Configuration.GetDefaultTtsVoice();
 
     // Get the volume and set the default to either what we have in the configuration or to half-volume. Why half-volume?
@@ -364,6 +363,45 @@ public bool SayUsernameWithMessage {
     }
   }
 
+  /// <summary>
+  ///   Gets the filtered list of voices, removing duplicates.
+  /// </summary>
+  /// <returns>The list of voice names.</returns>
+  private IEnumerable<string> GetFilteredTtsVoices() {
+    const string duplicatePostfix = " Desktop";
+    using var speech = new SpeechSynthesizer();
+    IEnumerable<string> allVoices = speech.GetInstalledVoices().Select(v => v.VoiceInfo.Name);
+    var unique = new HashSet<string>();
+    foreach (string voice in allVoices) {
+      // If the voice ends in the " Desktop" it means there could be a duplicate voice without that on the end
+      // e.g:
+      // Microsoft David Desktop
+      // vs
+      // Microsoft David
+      // 
+      // These both point to the same thing and we only need one of them. The tricky part is we can't be sure which one
+      // we will encounter so we have to check if the other exists and make sure only one of the two end up in the list.
+      if (voice.EndsWith(duplicatePostfix)) {
+        // If a " Desktop" voice has a voice without it in the list already, then don't add it. Skip this one.
+        if (unique.Contains(voice.Substring(0, voice.Length - duplicatePostfix.Length))) {
+          continue;
+        }
+      }
+      else {
+        // If it's not a desktop voice, check if this voice has another voice already with the " Desktop" on the end.
+        // If we find it, remove it and add this one instead.
+        if (unique.Contains(voice +  duplicatePostfix)) {
+          unique.Remove(voice + duplicatePostfix);
+        }
+      }
+      
+      unique.Add(voice);
+    }
+
+    // Sort them to be nice.
+    return unique.OrderByDescending(s => s);
+  }
+
   /// <summary>
   ///   Handles updating the configuration when the skip TTS keybind changes.
   /// </summary>