[AdvancedPaste]Add paste actions to allow transcoding of media files (#37188)

* [AdvancedPaste] Additional actions, including Image to text

* Spellcheck issue

* [AdvancedPaste] Paste as file and many other improvements

* Fixed typo

* Fixed typo

* [AdvancedPaste] Improved paste window menu layout

* [AdvancedPaste] Improved settings window layout

* [AdvancedPaste] Removed AudioToText for the moment

* Code cleanup

* Minor fixes

* [AdvancedPaste] Semantic Kernel support

* Changed log-line with potentially sensitive info

* Spellcheck issues

* Various improvements for Semantic Kernel

* Spellcheck issue

* Refactored Clipboard routines

* Added integration tests for KernelService

* Extra telemetry for AdvancedPaste

* Added 'Hotkey' suffix to AdvancedPaste_Settings telemetry event

* Added IsSavedQuery

* Added KernelQueryCache

* Refactoring

* Added KernelQueryCache to BugReportTool delete list

* Added opt-n for Semantic Kernel

* Fixed bug with KernelQueryCache

* Ability to view last AI chat message on error

* Improved kernel query cache

* Used System.IO.Abstractions and improved tests

* Fixed under-count of token usage

* Used Semantic Kernel icon

* Cleanup

* Add missing EndProject line

* Fix dependency version conflicts

* Fix NOTICE.md

* Correct place of SemanticKernel in NOTICE.md

* Unlinked CustomPreview toggle from AI

* Added Microsoft.Bcl.AsyncInterfaces dependency to AdvancedPaste

* Fixed NOTICE.md order

* Moved Custom Preview to behaviour section

* Made Image to Text raise error on empty output

* Added AIServiceBatchIntegrationTests

* Updated AIServiceBatchIntegrationTests

* Added prompt moderation

* [AdvancedPaste] Media Transcoding support

* Spellcheck issue

* Improved transcoding output profile and added tests

* Moved GPO Infobar to better location

* Added cancel button and minor bug fixes

* Fixed crash

* Minor cleanups

* Improved transcoding error messages

* Used software back when transcoding fails with hardware accerlation

* Added Reencode to spellcheck

* Spellcheck issue

---------

Co-authored-by: Jaime Bernardo <jaime@janeasystems.com>
Co-authored-by: Dustin L. Howett <dustin@howett.net>
Co-authored-by: Jeremy Sinclair <4016293+snickler@users.noreply.github.com>

src/settings-ui/Settings.UI.Library/AdvancedPasteAdditionalAction.cs

@@ -2,6 +2,7 @@
 // The Microsoft Corporation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
+using System.Collections.Generic;
 using System.Text.Json.Serialization;
 
 using Microsoft.PowerToys.Settings.UI.Library.Helpers;
@@ -36,4 +37,7 @@ public sealed partial class AdvancedPasteAdditionalAction : Observable, IAdvance
         get => _isShown;
         set => Set(ref _isShown, value);
     }
+
+    [JsonIgnore]
+    public IEnumerable<IAdvancedPasteAction> SubActions => [];
 }

src/settings-ui/Settings.UI.Library/AdvancedPasteAdditionalActions.cs

@@ -14,6 +14,7 @@ public sealed class AdvancedPasteAdditionalActions
     {
         public const string ImageToText = "image-to-text";
         public const string PasteAsFile = "paste-as-file";
+        public const string Transcode = "transcode";
     }
 
     [JsonPropertyName(PropertyNames.ImageToText)]
@@ -22,6 +23,22 @@ public sealed class AdvancedPasteAdditionalActions
     [JsonPropertyName(PropertyNames.PasteAsFile)]
     public AdvancedPastePasteAsFileAction PasteAsFile { get; init; } = new();
 
-    [JsonIgnore]
-    public IEnumerable<IAdvancedPasteAction> AllActions => new IAdvancedPasteAction[] { ImageToText, PasteAsFile }.Concat(PasteAsFile.SubActions);
+    [JsonPropertyName(PropertyNames.Transcode)]
+    public AdvancedPasteTranscodeAction Transcode { get; init; } = new();
+
+    public IEnumerable<IAdvancedPasteAction> GetAllActions()
+    {
+        Queue<IAdvancedPasteAction> queue = new([ImageToText, PasteAsFile, Transcode]);
+
+        while (queue.Count != 0)
+        {
+            var action = queue.Dequeue();
+            yield return action;
+
+            foreach (var subAction in action.SubActions)
+            {
+                queue.Enqueue(subAction);
+            }
+        }
+    }
 }

src/settings-ui/Settings.UI.Library/AdvancedPasteCustomAction.cs

@@ -3,6 +3,7 @@
 // See the LICENSE file in the project root for more information.
 
 using System;
+using System.Collections.Generic;
 using System.Text.Json.Serialization;
 
 using Microsoft.PowerToys.Settings.UI.Library.Helpers;
@@ -98,6 +99,9 @@ public sealed class AdvancedPasteCustomAction : Observable, IAdvancedPasteAction
         private set => Set(ref _isValid, value);
     }
 
+    [JsonIgnore]
+    public IEnumerable<IAdvancedPasteAction> SubActions => [];
+
     public object Clone()
     {
         AdvancedPasteCustomAction clone = new();

src/settings-ui/Settings.UI.Library/AdvancedPastePasteAsFileAction.cs

@@ -52,5 +52,5 @@ public sealed class AdvancedPastePasteAsFileAction : Observable, IAdvancedPasteA
     }
 
     [JsonIgnore]
-    public IEnumerable<AdvancedPasteAdditionalAction> SubActions => [PasteAsTxtFile, PasteAsPngFile, PasteAsHtmlFile];
+    public IEnumerable<IAdvancedPasteAction> SubActions => [PasteAsTxtFile, PasteAsPngFile, PasteAsHtmlFile];
 }

src/settings-ui/Settings.UI.Library/AdvancedPasteTranscodeAction.cs

@@ -0,0 +1,47 @@
+// Copyright (c) Microsoft Corporation
+// The Microsoft Corporation licenses this file to you under the MIT license.
+// See the LICENSE file in the project root for more information.
+
+using System.Collections.Generic;
+using System.Text.Json.Serialization;
+
+using Microsoft.PowerToys.Settings.UI.Library.Helpers;
+
+namespace Microsoft.PowerToys.Settings.UI.Library;
+
+public sealed class AdvancedPasteTranscodeAction : Observable, IAdvancedPasteAction
+{
+    public static class PropertyNames
+    {
+        public const string TranscodeToMp3 = "transcode-to-mp3";
+        public const string TranscodeToMp4 = "transcode-to-mp4";
+    }
+
+    private AdvancedPasteAdditionalAction _transcodeToMp3 = new();
+    private AdvancedPasteAdditionalAction _transcodeToMp4 = new();
+    private bool _isShown = true;
+
+    [JsonPropertyName("isShown")]
+    public bool IsShown
+    {
+        get => _isShown;
+        set => Set(ref _isShown, value);
+    }
+
+    [JsonPropertyName(PropertyNames.TranscodeToMp3)]
+    public AdvancedPasteAdditionalAction TranscodeToMp3
+    {
+        get => _transcodeToMp3;
+        init => Set(ref _transcodeToMp3, value);
+    }
+
+    [JsonPropertyName(PropertyNames.TranscodeToMp4)]
+    public AdvancedPasteAdditionalAction TranscodeToMp4
+    {
+        get => _transcodeToMp4;
+        init => Set(ref _transcodeToMp4, value);
+    }
+
+    [JsonIgnore]
+    public IEnumerable<IAdvancedPasteAction> SubActions => [TranscodeToMp3, TranscodeToMp4];
+}

src/settings-ui/Settings.UI.Library/IAdvancedPasteAction.cs

@@ -2,6 +2,7 @@
 // The Microsoft Corporation licenses this file to you under the MIT license.
 // See the LICENSE file in the project root for more information.
 
+using System.Collections.Generic;
 using System.ComponentModel;
 
 namespace Microsoft.PowerToys.Settings.UI.Library;
@@ -9,4 +10,6 @@ namespace Microsoft.PowerToys.Settings.UI.Library;
 public interface IAdvancedPasteAction : INotifyPropertyChanged
 {
     public bool IsShown { get; }
+
+    public IEnumerable<IAdvancedPasteAction> SubActions { get; }
 }

src/settings-ui/Settings.UI/SettingsXAML/Views/AdvancedPaste.xaml

@@ -276,6 +276,37 @@
                             </tkcontrols:SettingsExpander.Items>
                         </tkcontrols:SettingsExpander>
 
+                        <tkcontrols:SettingsExpander
+                            x:Uid="Transcode"
+                            DataContext="{x:Bind ViewModel.AdditionalActions.Transcode, Mode=OneWay}"
+                            HeaderIcon="{ui:FontIcon Glyph=&#xEA69;}"
+                            IsExpanded="{Binding IsShown, Mode=OneWay}">
+                            <tkcontrols:SettingsExpander.Content>
+                                <ToggleSwitch
+                                    IsOn="{Binding IsShown, Mode=TwoWay}"
+                                    OffContent=""
+                                    OnContent="" />
+                            </tkcontrols:SettingsExpander.Content>
+                            <tkcontrols:SettingsExpander.Items>
+                                <!--  HACK: For some weird reason, a ShortcutControl does not work correctly if it's the first or last item in the expander, so we add an invisible card.  -->
+                                <tkcontrols:SettingsCard Visibility="Collapsed" />
+                                <tkcontrols:SettingsCard
+                                    x:Uid="TranscodeToMp3"
+                                    DataContext="{Binding TranscodeToMp3, Mode=TwoWay}"
+                                    IsEnabled="{x:Bind ViewModel.AdditionalActions.Transcode.IsShown, Mode=OneWay}">
+                                    <ContentControl ContentTemplate="{StaticResource AdditionalActionTemplate}" />
+                                </tkcontrols:SettingsCard>
+                                <tkcontrols:SettingsCard
+                                    x:Uid="TranscodeToMp4"
+                                    DataContext="{Binding TranscodeToMp4, Mode=TwoWay}"
+                                    IsEnabled="{x:Bind ViewModel.AdditionalActions.Transcode.IsShown, Mode=OneWay}">
+                                    <ContentControl ContentTemplate="{StaticResource AdditionalActionTemplate}" />
+                                </tkcontrols:SettingsCard>
+                                <!--  HACK: For some weird reason, a ShortcutControl does not work correctly if it's the first or last item in the expander, so we add an invisible card.  -->
+                                <tkcontrols:SettingsCard Visibility="Collapsed" />
+                            </tkcontrols:SettingsExpander.Items>
+                        </tkcontrols:SettingsExpander>
+
                         <InfoBar
                             x:Uid="AdvancedPaste_ShortcutWarning"
                             IsClosable="False"

src/settings-ui/Settings.UI/Strings/en-us/Resources.resw

@@ -1934,6 +1934,15 @@ Made with 💗 by Microsoft and the PowerToys community.</value>
   <data name="PasteAsHtmlFile.Header" xml:space="preserve">
     <value>Paste as .html file</value>
   </data>
+  <data name="Transcode.Header" xml:space="preserve">
+    <value>Transcode audio / video</value>
+  </data>
+  <data name="TranscodeToMp3.Header" xml:space="preserve">
+    <value>Transcode to .mp3</value>
+  </data>
+  <data name="TranscodeToMp4.Header" xml:space="preserve">
+    <value>Transcode to .mp4 (H.264/AAC)</value>
+  </data>
   <data name="AdvancedPaste_EnableAIDialogOpenAIApiKey.Text" xml:space="preserve">
     <value>OpenAI API key:</value>
   </data>

src/settings-ui/Settings.UI/ViewModels/AdvancedPasteViewModel.cs

@@ -84,7 +84,7 @@ namespace Microsoft.PowerToys.Settings.UI.ViewModels
             _delayedTimer.Elapsed += DelayedTimer_Tick;
             _delayedTimer.AutoReset = false;
 
-            foreach (var action in _additionalActions.AllActions)
+            foreach (var action in _additionalActions.GetAllActions())
             {
                 action.PropertyChanged += OnAdditionalActionPropertyChanged;
             }
@@ -366,7 +366,7 @@ namespace Microsoft.PowerToys.Settings.UI.ViewModels
                           .Any(hotkey => WarnHotkeys.Contains(hotkey.ToString()));
 
         public bool IsAdditionalActionConflictingCopyShortcut =>
-            _additionalActions.AllActions
+            _additionalActions.GetAllActions()
                               .OfType<AdvancedPasteAdditionalAction>()
                               .Select(additionalAction => additionalAction.Shortcut)
                               .Any(hotkey => WarnHotkeys.Contains(hotkey.ToString()));