Feature/ux overhaul

.github/workflows/msbuild.yml

@@ -23,9 +23,9 @@ jobs:
     - name: Build SherpaOnnxConfig (self-contained, x64)
       run: dotnet publish SherpaOnnxConfig\SherpaOnnxConfig.csproj -c Release -r win-x64 --self-contained -p:PublishSingleFile=true -o ${{github.workspace}}\sherpa-config
 
-    - name: Copy merged_models.json (single-file publish drops it)
+    - name: Copy models.json (single-file publish drops it)
       shell: pwsh
-      run: Copy-Item SherpaOnnxConfig\merged_models.json sherpa-config\ -Force
+      run: Copy-Item SherpaOnnxConfig\models.json sherpa-config\ -Force
 
     - name: Verify Sherpa integration checks
       shell: pwsh
@@ -36,7 +36,7 @@ jobs:
         name: sherpa-onnx-config
         path: |
           sherpa-config/SherpaOnnxConfig.exe
-          sherpa-config/merged_models.json
+          sherpa-config/models.json
 
   build-voice-garden-ui:
     name: Build VoiceGarden.UI
@@ -84,19 +84,9 @@ jobs:
     - name: Add MSBuild to PATH
       uses: microsoft/setup-msbuild@v2
 
-    - name: Build AzureSpeechSDKShim (x64)
-      if: matrix.platform == 'x64'
-      working-directory: ${{github.workspace}}\AzureSpeechSDKShim
-      run: |
-        nuget restore AzureSpeechSDKShim.sln
-        msbuild /m /p:Configuration=${{env.BUILD_CONFIGURATION}} /p:Platform=x64 /p:OutDir=${{github.workspace}}\out\ AzureSpeechSDKShim.sln
-
-    - name: Build AzureSpeechSDKShim (x86)
-      if: matrix.platform == 'x86'
-      working-directory: ${{github.workspace}}\AzureSpeechSDKShim
-      run: |
-        nuget restore AzureSpeechSDKShim.sln
-        msbuild /m /p:Configuration=${{env.BUILD_CONFIGURATION}} /p:Platform=x86 /p:OutDir=${{github.workspace}}\out\ AzureSpeechSDKShim.sln
+    # AzureSpeechSDKShim is no longer built: the local Narrator voice feature
+    # it supported was dropped (TOS concerns) and the SDK runtime chain is
+    # excluded from the payload at compose time.
 
     - name: Build Arm64XForwarder (ARM64 only)
       if: matrix.platform == 'ARM64'
@@ -119,8 +109,7 @@ jobs:
         name: sherpa-onnx-config
         path: ${{github.workspace}}\out\
 
-    - name: Keep only merged_models.json in ARM64 utilities
-      if: matrix.platform == 'ARM64'
+    - name: Keep only models.json in utilities (drop the superseded SherpaOnnxConfig.exe)
       shell: pwsh
       run: Remove-Item out\SherpaOnnxConfig.exe -ErrorAction SilentlyContinue
 
@@ -228,6 +217,12 @@ jobs:
         # VoiceGarden.UI.exe (the main configuration app)
         Copy-Item artifacts\voice-garden-ui\VoiceGarden.UI.exe payload\ -Force
 
+        # The Azure Speech SDK runtime chain is not shipped (local Narrator
+        # voices dropped — TOS; the adapter never loads the SDK at runtime).
+        Get-ChildItem payload -Recurse -File |
+          Where-Object { $_.Name -like 'Microsoft.CognitiveServices.Speech.*.dll' -or $_.Name -in 'SpeechSDKShim.dll','SpeechSDKPatcher.exe' } |
+          Remove-Item -Force
+
         # Rust TTS wrapper native DLL (from NuGet package)
         dotnet restore VoiceGarden.UI\VoiceGarden.UI.csproj
         $rustDll = Get-ChildItem "$env:USERPROFILE\.nuget\packages\rustttswrapper.bindings" -Recurse -Filter "rust_tts_wrapper.dll" | Select-Object -First 1
@@ -294,6 +289,11 @@ jobs:
         # VoiceGarden.UI.exe goes to payload root
         cp voice-garden-ui/VoiceGarden.UI.exe . 2>/dev/null || true
 
+        # The Azure Speech SDK runtime chain is not shipped (local Narrator
+        # voices dropped — TOS; the adapter never loads the SDK at runtime).
+        rm -f x64/Microsoft.CognitiveServices.Speech.*.dll x64/SpeechSDKShim.dll x64/SpeechSDKPatcher.exe
+        rm -f x86/Microsoft.CognitiveServices.Speech.*.dll x86/SpeechSDKShim.dll x86/SpeechSDKPatcher.exe
+
         # MSI + setup.exe
         cp setup-msi/VoiceGardenSAPIAdapter.msi . 2>/dev/null || true
         cp setup-exe/setup.exe . 2>/dev/null || true

README.md

@@ -106,7 +106,7 @@ Fully offline neural TTS — no internet, no API keys, no cloud dependency.
 ### Downloading models
 Models are stored in `%LOCALAPPDATA%\VoiceGardenSAPIAdapter\models\`. Download via:
 - **UI:** SherpaOnnx tab → select models → Download Selected (built-in extraction, no 7-Zip needed)
-- **CLI:** `VoiceGarden.UI.exe models download kokoro-en-en-19`
+- **CLI:** `VoiceGarden.UI.exe models download kokoro-en-v0_19`
 
 ### Grid 3 compatibility
 Grid 3 (`System.Speech`) only selects voices from HKLM registry tokens. Use **Install to SAPI** to promote voices to HKLM. Word boundary events work with Grid3 (tested, no crash).
@@ -148,7 +148,7 @@ Each cloud engine needs its API key set in the Engine Config tab. Search voices
 ```powershell
 Add-Type -AssemblyName "System.Speech"
 $s = New-Object System.Speech.Synthesis.SpeechSynthesizer
-$s.SelectVoice("kokoro-en-en-19")       # or any voice name
+$s.SelectVoice("kokoro-en-v0_19")       # or any voice name
 $s.Speak("Hello, this is a test.")
 ```
 

Setup/Package.wxs

@@ -8,10 +8,17 @@
     <MajorUpgrade
       AllowSameVersionUpgrades="yes"
       IgnoreRemoveFailure="yes"
-      Schedule="afterInstallFinalize"
+      Schedule="afterInstallValidate"
       DowngradeErrorMessage="A newer version of [ProductName] is already installed." />
     <MediaTemplate EmbedCab="yes" />
 
+    <!--
+      Running apps are closed by the SetupLauncher bootstrapper before the
+      MSI starts (ask-first, terminate on refusal) — their locked files
+      otherwise fail the upgrade. Kept out of util:CloseApplication because
+      the PanelSw WiX build cannot load official wixext packages.
+    -->
+
     <StandardDirectory Id="ProgramFiles6432Folder">
       <Directory Id="INSTALLFOLDER" Name="$(var.InstallFolderName)" />
     </StandardDirectory>

Setup/Setup.wixproj

@@ -10,4 +10,10 @@
     <ProjectUrl Condition="'$(ProjectUrl)'==''">https://github.com/gexgd0419/VoiceGardenSAPIAdapter</ProjectUrl>
     <DefineConstants>ProductVersion=$(ProductVersion);PayloadDir=$(PayloadDir);ProductName=$(ProductName);Manufacturer=$(Manufacturer);InstallFolderName=$(InstallFolderName);InstallerShortcutName=$(InstallerShortcutName);ProjectUrl=$(ProjectUrl)</DefineConstants>
   </PropertyGroup>
+
+  <ItemGroup>
+    <!-- Close-application prompting is handled by the SetupLauncher
+         bootstrapper (the PanelSw WiX build rejects official wixext
+         packages, so util:CloseApplication is not usable here). -->
+  </ItemGroup>
 </Project>

SetupLauncher/Program.cs

@@ -39,6 +39,10 @@ static int Main(string[] args)
                     return 3;
                 }
 
+                // Uninstall removes the apps' files too — they must not run.
+                if (!EnsureAppsClosed(quiet))
+                    return 1602; // ERROR_INSTALL_USEREXIT
+
                 msiexecArgs = $"/x {productCode}";
                 if (quiet)
                     msiexecArgs += " /qn";
@@ -49,6 +53,11 @@ static int Main(string[] args)
             }
             else
             {
+                // Upgrades replace the apps' files — a running instance keeps
+                // them locked and the MSI fails or leaves a half-mixed install.
+                if (!EnsureAppsClosed(quiet))
+                    return 1602; // ERROR_INSTALL_USEREXIT
+
                 msiexecArgs = $"/i \"{msiPath}\"";
                 if (quiet)
                     msiexecArgs += " /qn";
@@ -107,6 +116,72 @@ static int Main(string[] args)
     static bool HasArg(string[] args, string needle) =>
         args.Any(a => string.Equals(a, needle, StringComparison.OrdinalIgnoreCase));
 
+    /// <summary>Apps whose files the MSI replaces — they must be closed first.</summary>
+    static readonly string[] AppProcessNames = { "VoiceGarden.UI", "SherpaOnnxConfig" };
+
+    /// <summary>
+    /// Make sure none of the shipped apps are running. Asks the user first
+    /// (with the option to close them automatically); silent runs close
+    /// everything without asking. Returns false when the user declines.
+    /// </summary>
+    static bool EnsureAppsClosed(bool quiet)
+    {
+        if (!EnumerateAppProcesses().Any())
+            return true; // nothing was running
+
+        if (quiet)
+        {
+            CloseAppProcesses();
+            return true;
+        }
+
+        var choice = MessageBox.Show(
+            "VoiceGarden is currently running and must be closed before setup can continue.\n\n" +
+            "Click OK to close it now and continue, or Cancel to stop setup.",
+            Branding.SetupCaption,
+            MessageBoxButtons.OKCancel,
+            MessageBoxIcon.Information,
+            MessageBoxDefaultButton.Button1);
+        if (choice != DialogResult.OK)
+            return false;
+
+        CloseAppProcesses();
+
+        // If something still refuses to die, say so rather than failing
+        // the MSI with a cryptic file-in-use error.
+        if (EnumerateAppProcesses().Any())
+        {
+            Notify("Could not close VoiceGarden (another user may be running it, or it may be busy). " +
+                   "Close it manually and run setup again.",
+                Branding.SetupCaption, quiet: false, error: true);
+            return false;
+        }
+        return true;
+    }
+
+    static IEnumerable<Process> EnumerateAppProcesses() =>
+        AppProcessNames.SelectMany(Process.GetProcessesByName).Distinct();
+
+    static void CloseAppProcesses()
+    {
+        foreach (var proc in EnumerateAppProcesses().ToList())
+        {
+            try
+            {
+                // Ask nicely first (WM_CLOSE); the single-instance app exits on it.
+                proc.CloseMainWindow();
+                if (!proc.WaitForExit(3000))
+                    proc.Kill();
+            }
+            catch
+            {
+                try { proc.Kill(); } catch { }
+            }
+        }
+        // Give the OS a moment to release file handles.
+        Thread.Sleep(1500);
+    }
+
     static int RunMsiexec(string arguments)
     {
         var psi = new ProcessStartInfo