Adding Terminal Velocity Check for experimental API (#4906)

microsoft · Nov 22, 2024 · d6e1cfd · d6e1cfd
1 parent e4227ec
commit d6e1cfd
Show file tree

Hide file tree

Showing 7 changed files with 96 additions and 7 deletions.
diff --git a/build/AzurePipelinesTemplates/WindowsAppSDK-SetupBuildEnvironment-Steps.yml b/build/AzurePipelinesTemplates/WindowsAppSDK-SetupBuildEnvironment-Steps.yml
@@ -179,6 +179,14 @@ steps:
     arguments: -Path $(Build.SourcesDirectory)\dev\common\TerminalVelocityFeatures-PackageManager.xml -Channel $(channel) -Language C++ -Namespace Microsoft.Windows.Management.Deployment -Output $(Build.SourcesDirectory)\dev\common\TerminalVelocityFeatures-PackageManager.h
     workingDirectory: '$(Build.SourcesDirectory)'
 
+- task: powershell@2
+  displayName: 'Create CameraCaptureUI TerminalVelocity features'
+  inputs:
+    targetType: filePath
+    filePath: tools\TerminalVelocity\Generate-TerminalVelocityFeatures.ps1
+    arguments: -Path $(Build.SourcesDirectory)\dev\common\TerminalVelocityFeatures-CameraCaptureUI.xml -Channel $(channel) -Language C++ -Namespace Microsoft.Windows.Media.Capture -Output $(Build.SourcesDirectory)\dev\common\TerminalVelocityFeatures-CameraCaptureUI.h
+    workingDirectory: '$(Build.SourcesDirectory)'
+
 - task: powershell@2
   name: UpdateTraceloggingConfig
   inputs:

diff --git a/dev/Common/TerminalVelocityFeatures-CameraCaptureUI.h b/dev/Common/TerminalVelocityFeatures-CameraCaptureUI.h
@@ -0,0 +1,32 @@
+// Copyright (c) Microsoft Corporation and Contributors.
+// Licensed under the MIT License.
+
+// THIS FILE IS AUTOMATICALLY GENERATED; DO NOT EDIT IT
+
+// INPUT FILE: dev\common\TerminalVelocityFeatures-CameraCaptureUI.xml
+// OPTIONS: -Channel Experimental -Language C++ -Namespace Microsoft.Windows.Media.Capture -Path dev\common\TerminalVelocityFeatures-CameraCaptureUI.xml -Output dev\common\TerminalVelocityFeatures-CameraCaptureUI.h
+
+#if defined(__midlrt)
+namespace features
+{
+    feature_name Feature_CameraCaptureUI = { DisabledByDefault, FALSE };
+}
+#endif // defined(__midlrt)
+
+// Feature constants
+#define WINDOWSAPPRUNTIME_MICROSOFT_WINDOWS_MEDIA_CAPTURE_FEATURE_CAMERACAPTUREUI_ENABLED 1
+
+#if defined(__cplusplus)
+
+namespace Microsoft::Windows::Media::Capture
+{
+
+__pragma(detect_mismatch("ODR_violation_WINDOWSAPPRUNTIME_MICROSOFT_WINDOWS_MEDIA_CAPTURE_FEATURE_CAMERACAPTUREUI_ENABLED_mismatch", "AlwaysEnabled"))
+struct Feature_CameraCaptureUI
+{
+    static constexpr bool IsEnabled() { return WINDOWSAPPRUNTIME_MICROSOFT_WINDOWS_MEDIA_CAPTURE_FEATURE_CAMERACAPTUREUI_ENABLED == 1; }
+};
+
+} // namespace Microsoft.Windows.Media.Capture
+
+#endif // defined(__cplusplus)
diff --git a/dev/Common/TerminalVelocityFeatures-CameraCaptureUI.xml b/dev/Common/TerminalVelocityFeatures-CameraCaptureUI.xml
@@ -0,0 +1,20 @@
+<?xml version="1.0"?>
+<features xmlns="http://microsoft.com/windowsappsdk/TerminalVelocity/20210729/TerminalVelocityFeatures.xsd">
+
+  <!-- Copyright (c) Microsoft Corporation. All rights reserved.
+     Licensed under the MIT License. See LICENSE in the project root for license information.
+-->
+
+  <!-- See docs/Coding-Guidelines/TerminalVelocity.md for more info.  -->
+
+  <!-- Enabled variants -->
+  <feature>
+    <name>Feature_CameraCaptureUI</name>
+    <description>CameraCaptureUI for the WindowsAppRuntime</description>
+    <state>AlwaysEnabled</state>
+    <alwaysDisabledChannelTokens>
+      <channelToken>Preview</channelToken>
+      <channelToken>Stable</channelToken>
+    </alwaysDisabledChannelTokens>
+  </feature>
+</features>
diff --git a/dev/Interop/CameraCaptureUI/CameraCaptureUI/CameraCaptureUI.h b/dev/Interop/CameraCaptureUI/CameraCaptureUI/CameraCaptureUI.h
@@ -5,7 +5,7 @@
 #include "CameraCaptureUIPhotoCaptureSettings.h"
 #include "CameraCaptureUIVideoCaptureSettings.h"
 #include "TelemetryHelper.h"
-
+#include <TerminalVelocityFeatures-CameraCaptureUI.h>
 
 namespace winrt::Microsoft::Windows::Media::Capture::implementation
 {
@@ -20,6 +20,7 @@ namespace winrt::Microsoft::Windows::Media::Capture::implementation
         CameraCaptureUI(winrt::Microsoft::UI::WindowId const& windowId) :
             m_windowId(windowId)
         {
+            THROW_HR_IF(E_NOTIMPL, !::Microsoft::Windows::Media::Capture::Feature_CameraCaptureUI::IsEnabled());
         }
 
         Microsoft::Windows::Media::Capture::CameraCaptureUIPhotoCaptureSettings PhotoSettings()

diff --git a/dev/Interop/CameraCaptureUI/CameraCaptureUI/CameraCaptureUI.idl b/dev/Interop/CameraCaptureUI/CameraCaptureUI/CameraCaptureUI.idl
@@ -1,5 +1,6 @@
 // Copyright (c) Microsoft Corporation. All rights reserved.
 // Licensed under the MIT License. See LICENSE in the project root for license information.
+#include <TerminalVelocityFeatures-CameraCaptureUI.h>
 
 namespace Microsoft.Windows.Media.Capture
 {
@@ -73,6 +74,7 @@ namespace Microsoft.Windows.Media.Capture
     }
 
     [contract(CameraCaptureUIContract, 1)]
+    [feature(Feature_CameraCaptureUI)]
     runtimeclass CameraCaptureUI
     {
         CameraCaptureUI(Microsoft.UI.WindowId windowId);

diff --git a/test/CameraCaptureUITests/APITests.cpp b/test/CameraCaptureUITests/APITests.cpp
@@ -9,6 +9,7 @@
 #include <mutex>
 #include <winrt/Windows.Storage.h>
 #include <winrt/Windows.Foundation.h>
+#include <TerminalVelocityFeatures-CameraCaptureUI.h>
 
 using namespace std::chrono_literals;
 using namespace WEX::Common;
@@ -59,6 +60,11 @@ namespace CameraCaptureUITests
         // Focusing solely on functional tests for now. 
         TEST_METHOD(CapturePhoto_ShouldReturnFile)
         {
+            if (!::Microsoft::Windows::Media::Capture::Feature_CameraCaptureUI::IsEnabled())
+            {
+                Log::Result(TestResults::Skipped, L"CameraCaptureUI API Features are not enabled.");
+                return;
+            }
             try
             {
                 auto parentWindow = ::GetForegroundWindow();
@@ -96,6 +102,11 @@ namespace CameraCaptureUITests
         }
         TEST_METHOD(VerifyRequestedPhotoFormatsAreReadCorrectly)
         {
+            if (!::Microsoft::Windows::Media::Capture::Feature_CameraCaptureUI::IsEnabled())
+            {
+                Log::Result(TestResults::Skipped, L"CameraCaptureUI API Features are not enabled.");
+                return;
+            }
             // Arrange
             auto parentWindow = ::GetForegroundWindow();
             winrt::Microsoft::UI::WindowId windowId{ reinterpret_cast<uint64_t>(parentWindow) };
@@ -117,6 +128,11 @@ namespace CameraCaptureUITests
 
         TEST_METHOD(VerifyRequestedVideoFormatsAreReadCorrectly)
         {
+            if (!::Microsoft::Windows::Media::Capture::Feature_CameraCaptureUI::IsEnabled())
+            {
+                Log::Result(TestResults::Skipped, L"CameraCaptureUI API Features are not enabled.");
+                return;
+            }
             // Arrange
             auto parentWindow = ::GetForegroundWindow();
             winrt::Microsoft::UI::WindowId windowId{ reinterpret_cast<uint64_t>(parentWindow) };
@@ -132,6 +148,11 @@ namespace CameraCaptureUITests
         }
         TEST_METHOD(VerifyMaxVideoResolutionValues)
         {
+            if (!::Microsoft::Windows::Media::Capture::Feature_CameraCaptureUI::IsEnabled())
+            {
+                Log::Result(TestResults::Skipped, L"CameraCaptureUI API Features are not enabled.");
+                return;
+            }
             // Arrange
             auto parentWindow = ::GetForegroundWindow();
             winrt::Microsoft::UI::WindowId windowId{ reinterpret_cast<uint64_t>(parentWindow) };
@@ -156,6 +177,11 @@ namespace CameraCaptureUITests
 
         TEST_METHOD(VerifyMaxPhotoResolutionValues)
         {
+            if (!::Microsoft::Windows::Media::Capture::Feature_CameraCaptureUI::IsEnabled())
+            {
+                Log::Result(TestResults::Skipped, L"CameraCaptureUI API Features are not enabled.");
+                return;
+            }
             // Arrange
             auto parentWindow = ::GetForegroundWindow();
             winrt::Microsoft::UI::WindowId windowId{ reinterpret_cast<uint64_t>(parentWindow) };

diff --git a/test/CameraCaptureUITests/CameraCaptureUITests.vcxproj b/test/CameraCaptureUITests/CameraCaptureUITests.vcxproj
@@ -107,7 +107,7 @@
       <ConformanceMode>true</ConformanceMode>
       <PrecompiledHeader>Use</PrecompiledHeader>
       <PrecompiledHeaderFile>pch.h</PrecompiledHeaderFile>
-      <AdditionalIncludeDirectories>$(ProjectDir)..\inc;$(ProjectDir)..\..\dev\WindowsAppRuntime_BootstrapDLL\</AdditionalIncludeDirectories>
+      <AdditionalIncludeDirectories>$(ProjectDir)..\inc;$(ProjectDir)..\..\dev\WindowsAppRuntime_BootstrapDLL;$(MSBuildProjectDirectory)\..\..\dev\common</AdditionalIncludeDirectories>
     </ClCompile>
     <Link>
       <SubSystem>Windows</SubSystem>
@@ -125,7 +125,7 @@
       <ConformanceMode>true</ConformanceMode>
       <PrecompiledHeader>Use</PrecompiledHeader>
       <PrecompiledHeaderFile>pch.h</PrecompiledHeaderFile>
-      <AdditionalIncludeDirectories>$(ProjectDir)..\inc;$(ProjectDir)..\..\dev\WindowsAppRuntime_BootstrapDLL\</AdditionalIncludeDirectories>
+      <AdditionalIncludeDirectories>$(ProjectDir)..\inc;$(ProjectDir)..\..\dev\WindowsAppRuntime_BootstrapDLL\;$(MSBuildProjectDirectory)\..\..\dev\common</AdditionalIncludeDirectories>
     </ClCompile>
     <Link>
       <SubSystem>Windows</SubSystem>
@@ -143,7 +143,7 @@
       <ConformanceMode>true</ConformanceMode>
       <PrecompiledHeader>Use</PrecompiledHeader>
       <PrecompiledHeaderFile>pch.h</PrecompiledHeaderFile>
-      <AdditionalIncludeDirectories>$(ProjectDir)..\inc;$(ProjectDir)..\..\dev\WindowsAppRuntime_BootstrapDLL\</AdditionalIncludeDirectories>
+      <AdditionalIncludeDirectories>$(ProjectDir)..\inc;$(ProjectDir)..\..\dev\WindowsAppRuntime_BootstrapDLL\;$(MSBuildProjectDirectory)\..\..\dev\common</AdditionalIncludeDirectories>
     </ClCompile>
     <Link>
       <SubSystem>Windows</SubSystem>
@@ -161,7 +161,7 @@
       <ConformanceMode>true</ConformanceMode>
       <PrecompiledHeader>Use</PrecompiledHeader>
       <PrecompiledHeaderFile>pch.h</PrecompiledHeaderFile>
-      <AdditionalIncludeDirectories>$(ProjectDir)..\inc;$(ProjectDir)..\..\dev\WindowsAppRuntime_BootstrapDLL\</AdditionalIncludeDirectories>
+      <AdditionalIncludeDirectories>$(ProjectDir)..\inc;$(ProjectDir)..\..\dev\WindowsAppRuntime_BootstrapDLL\;$(MSBuildProjectDirectory)\..\..\dev\common</AdditionalIncludeDirectories>
     </ClCompile>
     <Link>
       <SubSystem>Windows</SubSystem>
@@ -179,7 +179,7 @@
       <ConformanceMode>true</ConformanceMode>
       <PrecompiledHeader>Use</PrecompiledHeader>
       <PrecompiledHeaderFile>pch.h</PrecompiledHeaderFile>
-      <AdditionalIncludeDirectories>$(ProjectDir)..\inc;$(ProjectDir)..\..\dev\WindowsAppRuntime_BootstrapDLL\</AdditionalIncludeDirectories>
+      <AdditionalIncludeDirectories>$(ProjectDir)..\inc;$(ProjectDir)..\..\dev\WindowsAppRuntime_BootstrapDLL\;$(MSBuildProjectDirectory)\..\..\dev\common</AdditionalIncludeDirectories>
     </ClCompile>
     <Link>
       <SubSystem>Windows</SubSystem>
@@ -197,7 +197,7 @@
       <ConformanceMode>true</ConformanceMode>
       <PrecompiledHeader>Use</PrecompiledHeader>
       <PrecompiledHeaderFile>pch.h</PrecompiledHeaderFile>
-      <AdditionalIncludeDirectories>$(ProjectDir)..\inc;$(ProjectDir)..\..\dev\WindowsAppRuntime_BootstrapDLL\</AdditionalIncludeDirectories>
+      <AdditionalIncludeDirectories>$(ProjectDir)..\inc;$(ProjectDir)..\..\dev\WindowsAppRuntime_BootstrapDLL\;$(MSBuildProjectDirectory)\..\..\dev\common</AdditionalIncludeDirectories>
     </ClCompile>
     <Link>
       <SubSystem>Windows</SubSystem>