Pin OpenCV dependency artifact to v142 toolset

Author: chammoru

.github/workflows/opencv-dependency.yml

@@ -22,6 +22,7 @@ jobs:
 
     env:
       OPENCV_VERSION: ${{ inputs.opencv_version || '4.3.0' }}
+      OPENCV_TOOLSET: v142
 
     steps:
       - name: Checkout
@@ -35,16 +36,17 @@ jobs:
         run: |
           .\build\Build-OpenCvDependency.ps1 `
             -Version $env:OPENCV_VERSION `
+            -Toolset $env:OPENCV_TOOLSET `
             -Configurations Release,Debug `
             -Platform x64
 
       - name: Package dependency
         id: package
         shell: pwsh
         run: |
-          $packageName = "Q1View-opencv-$($env:OPENCV_VERSION)-msvc-x64-static-mt.zip"
+          $packageName = "Q1View-opencv-$($env:OPENCV_VERSION)-msvc-$($env:OPENCV_TOOLSET)-x64-static-mt.zip"
           $hashFile = "$packageName.sha256.txt"
-          $tagName = "deps-opencv-$($env:OPENCV_VERSION)-msvc-x64-static-mt"
+          $tagName = "deps-opencv-$($env:OPENCV_VERSION)-msvc-$($env:OPENCV_TOOLSET)-x64-static-mt"
           $installRoot = ".deps\opencv-$($env:OPENCV_VERSION)-build\install"
 
           if (-not (Test-Path "$installRoot\include\opencv2\core.hpp")) {
@@ -59,6 +61,7 @@ jobs:
             "# OpenCV dependency for Q1View",
             "",
             "- OpenCV: $env:OPENCV_VERSION",
+            "- MSVC toolset: $env:OPENCV_TOOLSET",
             "- Package: $packageName",
             "- SHA256: $hash",
             "",
@@ -73,8 +76,7 @@ jobs:
         uses: softprops/action-gh-release@v2
         with:
           tag_name: ${{ steps.package.outputs.tag_name }}
-          target_commitish: ${{ github.sha }}
-          name: OpenCV ${{ env.OPENCV_VERSION }} dependency
+          name: OpenCV ${{ env.OPENCV_VERSION }} dependency (${{ env.OPENCV_TOOLSET }})
           body_path: RELEASE_NOTES.md
           overwrite_files: true
           fail_on_unmatched_files: true

OpenCV4Debug.props

@@ -4,14 +4,15 @@
   <PropertyGroup Label="UserMacros" />
   <PropertyGroup>
     <Q1ViewOpenCvVersion Condition="'$(Q1ViewOpenCvVersion)' == ''">4.3.0</Q1ViewOpenCvVersion>
-    <Q1ViewOpenCvAssetName Condition="'$(Q1ViewOpenCvAssetName)' == ''">Q1View-opencv-$(Q1ViewOpenCvVersion)-msvc-x64-static-mt.zip</Q1ViewOpenCvAssetName>
-    <Q1ViewOpenCvReleaseTag Condition="'$(Q1ViewOpenCvReleaseTag)' == ''">deps-opencv-$(Q1ViewOpenCvVersion)-msvc-x64-static-mt</Q1ViewOpenCvReleaseTag>
+    <Q1ViewOpenCvToolset Condition="'$(Q1ViewOpenCvToolset)' == ''">v142</Q1ViewOpenCvToolset>
+    <Q1ViewOpenCvAssetName Condition="'$(Q1ViewOpenCvAssetName)' == ''">Q1View-opencv-$(Q1ViewOpenCvVersion)-msvc-$(Q1ViewOpenCvToolset)-x64-static-mt.zip</Q1ViewOpenCvAssetName>
+    <Q1ViewOpenCvReleaseTag Condition="'$(Q1ViewOpenCvReleaseTag)' == ''">deps-opencv-$(Q1ViewOpenCvVersion)-msvc-$(Q1ViewOpenCvToolset)-x64-static-mt</Q1ViewOpenCvReleaseTag>
     <Q1ViewOpenCvArchiveUrl Condition="'$(Q1VIEW_OPENCV_URL)' != ''">$(Q1VIEW_OPENCV_URL)</Q1ViewOpenCvArchiveUrl>
     <Q1ViewOpenCvArchiveUrl Condition="'$(Q1ViewOpenCvArchiveUrl)' == ''">https://github.com/chammoru/Q1View/releases/download/$(Q1ViewOpenCvReleaseTag)/$(Q1ViewOpenCvAssetName)</Q1ViewOpenCvArchiveUrl>
     <Q1ViewOpenCvArchivePath Condition="'$(Q1VIEW_OPENCV_ARCHIVE)' != ''">$(Q1VIEW_OPENCV_ARCHIVE)</Q1ViewOpenCvArchivePath>
     <Q1ViewOpenCvSha256 Condition="'$(Q1VIEW_OPENCV_SHA256)' != ''">$(Q1VIEW_OPENCV_SHA256)</Q1ViewOpenCvSha256>
     <Q1ViewOpenCvInstallRoot Condition="'$(Q1VIEW_OPENCV_ROOT)' != ''">$(Q1VIEW_OPENCV_ROOT)</Q1ViewOpenCvInstallRoot>
-    <Q1ViewOpenCvInstallRoot Condition="'$(Q1ViewOpenCvInstallRoot)' == ''">$(MSBuildThisFileDirectory).deps\opencv-$(Q1ViewOpenCvVersion)-msvc-x64-static-mt</Q1ViewOpenCvInstallRoot>
+    <Q1ViewOpenCvInstallRoot Condition="'$(Q1ViewOpenCvInstallRoot)' == ''">$(MSBuildThisFileDirectory).deps\opencv-$(Q1ViewOpenCvVersion)-msvc-$(Q1ViewOpenCvToolset)-x64-static-mt</Q1ViewOpenCvInstallRoot>
     <Q1ViewOpenCvBinaryPrefix Condition="'$(Q1ViewOpenCvBinaryPrefix)' == ''">x64\vc16</Q1ViewOpenCvBinaryPrefix>
     <Q1ViewOpenCvLibDir>$(Q1ViewOpenCvInstallRoot)\$(Q1ViewOpenCvBinaryPrefix)\staticlib</Q1ViewOpenCvLibDir>
     <Q1ViewOpenCvBinDir>$(Q1ViewOpenCvInstallRoot)\$(Q1ViewOpenCvBinaryPrefix)\bin</Q1ViewOpenCvBinDir>
@@ -22,7 +23,7 @@
           BeforeTargets="PrepareForBuild"
           Condition="'$(Platform)' == 'x64' and (!Exists('$(Q1ViewOpenCvInstallRoot)\include\opencv2\core.hpp') or !Exists('$(Q1ViewOpenCvCoreLib)') or !Exists('$(Q1ViewOpenCvStamp)'))">
     <Message Text="Preparing OpenCV $(Q1ViewOpenCvVersion) dependency at $(Q1ViewOpenCvInstallRoot)" Importance="High" />
-    <Exec Command="powershell -NoProfile -ExecutionPolicy Bypass -File &quot;$(MSBuildThisFileDirectory)build\Ensure-OpenCvDependency.ps1&quot; -Version &quot;$(Q1ViewOpenCvVersion)&quot; -InstallRoot &quot;$(Q1ViewOpenCvInstallRoot)&quot; -ArchiveUrl &quot;$(Q1ViewOpenCvArchiveUrl)&quot; -ArchivePath &quot;$(Q1ViewOpenCvArchivePath)&quot; -Sha256 &quot;$(Q1ViewOpenCvSha256)&quot; -Configuration &quot;$(Configuration)&quot; -Platform &quot;$(Platform)&quot; -BinaryPrefix &quot;$(Q1ViewOpenCvBinaryPrefix)&quot;" />
+    <Exec Command="powershell -NoProfile -ExecutionPolicy Bypass -File &quot;$(MSBuildThisFileDirectory)build\Ensure-OpenCvDependency.ps1&quot; -Version &quot;$(Q1ViewOpenCvVersion)&quot; -Toolset &quot;$(Q1ViewOpenCvToolset)&quot; -InstallRoot &quot;$(Q1ViewOpenCvInstallRoot)&quot; -ArchiveUrl &quot;$(Q1ViewOpenCvArchiveUrl)&quot; -ArchivePath &quot;$(Q1ViewOpenCvArchivePath)&quot; -Sha256 &quot;$(Q1ViewOpenCvSha256)&quot; -Configuration &quot;$(Configuration)&quot; -Platform &quot;$(Platform)&quot; -BinaryPrefix &quot;$(Q1ViewOpenCvBinaryPrefix)&quot;" />
   </Target>
   <Target Name="Q1ViewCopyOpenCvRuntime"
           AfterTargets="Build"

OpenCV4Release.props

@@ -4,14 +4,15 @@
   <PropertyGroup Label="UserMacros" />
   <PropertyGroup>
     <Q1ViewOpenCvVersion Condition="'$(Q1ViewOpenCvVersion)' == ''">4.3.0</Q1ViewOpenCvVersion>
-    <Q1ViewOpenCvAssetName Condition="'$(Q1ViewOpenCvAssetName)' == ''">Q1View-opencv-$(Q1ViewOpenCvVersion)-msvc-x64-static-mt.zip</Q1ViewOpenCvAssetName>
-    <Q1ViewOpenCvReleaseTag Condition="'$(Q1ViewOpenCvReleaseTag)' == ''">deps-opencv-$(Q1ViewOpenCvVersion)-msvc-x64-static-mt</Q1ViewOpenCvReleaseTag>
+    <Q1ViewOpenCvToolset Condition="'$(Q1ViewOpenCvToolset)' == ''">v142</Q1ViewOpenCvToolset>
+    <Q1ViewOpenCvAssetName Condition="'$(Q1ViewOpenCvAssetName)' == ''">Q1View-opencv-$(Q1ViewOpenCvVersion)-msvc-$(Q1ViewOpenCvToolset)-x64-static-mt.zip</Q1ViewOpenCvAssetName>
+    <Q1ViewOpenCvReleaseTag Condition="'$(Q1ViewOpenCvReleaseTag)' == ''">deps-opencv-$(Q1ViewOpenCvVersion)-msvc-$(Q1ViewOpenCvToolset)-x64-static-mt</Q1ViewOpenCvReleaseTag>
     <Q1ViewOpenCvArchiveUrl Condition="'$(Q1VIEW_OPENCV_URL)' != ''">$(Q1VIEW_OPENCV_URL)</Q1ViewOpenCvArchiveUrl>
     <Q1ViewOpenCvArchiveUrl Condition="'$(Q1ViewOpenCvArchiveUrl)' == ''">https://github.com/chammoru/Q1View/releases/download/$(Q1ViewOpenCvReleaseTag)/$(Q1ViewOpenCvAssetName)</Q1ViewOpenCvArchiveUrl>
     <Q1ViewOpenCvArchivePath Condition="'$(Q1VIEW_OPENCV_ARCHIVE)' != ''">$(Q1VIEW_OPENCV_ARCHIVE)</Q1ViewOpenCvArchivePath>
     <Q1ViewOpenCvSha256 Condition="'$(Q1VIEW_OPENCV_SHA256)' != ''">$(Q1VIEW_OPENCV_SHA256)</Q1ViewOpenCvSha256>
     <Q1ViewOpenCvInstallRoot Condition="'$(Q1VIEW_OPENCV_ROOT)' != ''">$(Q1VIEW_OPENCV_ROOT)</Q1ViewOpenCvInstallRoot>
-    <Q1ViewOpenCvInstallRoot Condition="'$(Q1ViewOpenCvInstallRoot)' == ''">$(MSBuildThisFileDirectory).deps\opencv-$(Q1ViewOpenCvVersion)-msvc-x64-static-mt</Q1ViewOpenCvInstallRoot>
+    <Q1ViewOpenCvInstallRoot Condition="'$(Q1ViewOpenCvInstallRoot)' == ''">$(MSBuildThisFileDirectory).deps\opencv-$(Q1ViewOpenCvVersion)-msvc-$(Q1ViewOpenCvToolset)-x64-static-mt</Q1ViewOpenCvInstallRoot>
     <Q1ViewOpenCvBinaryPrefix Condition="'$(Q1ViewOpenCvBinaryPrefix)' == ''">x64\vc16</Q1ViewOpenCvBinaryPrefix>
     <Q1ViewOpenCvLibDir>$(Q1ViewOpenCvInstallRoot)\$(Q1ViewOpenCvBinaryPrefix)\staticlib</Q1ViewOpenCvLibDir>
     <Q1ViewOpenCvBinDir>$(Q1ViewOpenCvInstallRoot)\$(Q1ViewOpenCvBinaryPrefix)\bin</Q1ViewOpenCvBinDir>
@@ -22,7 +23,7 @@
           BeforeTargets="PrepareForBuild"
           Condition="'$(Platform)' == 'x64' and (!Exists('$(Q1ViewOpenCvInstallRoot)\include\opencv2\core.hpp') or !Exists('$(Q1ViewOpenCvCoreLib)') or !Exists('$(Q1ViewOpenCvStamp)'))">
     <Message Text="Preparing OpenCV $(Q1ViewOpenCvVersion) dependency at $(Q1ViewOpenCvInstallRoot)" Importance="High" />
-    <Exec Command="powershell -NoProfile -ExecutionPolicy Bypass -File &quot;$(MSBuildThisFileDirectory)build\Ensure-OpenCvDependency.ps1&quot; -Version &quot;$(Q1ViewOpenCvVersion)&quot; -InstallRoot &quot;$(Q1ViewOpenCvInstallRoot)&quot; -ArchiveUrl &quot;$(Q1ViewOpenCvArchiveUrl)&quot; -ArchivePath &quot;$(Q1ViewOpenCvArchivePath)&quot; -Sha256 &quot;$(Q1ViewOpenCvSha256)&quot; -Configuration &quot;$(Configuration)&quot; -Platform &quot;$(Platform)&quot; -BinaryPrefix &quot;$(Q1ViewOpenCvBinaryPrefix)&quot;" />
+    <Exec Command="powershell -NoProfile -ExecutionPolicy Bypass -File &quot;$(MSBuildThisFileDirectory)build\Ensure-OpenCvDependency.ps1&quot; -Version &quot;$(Q1ViewOpenCvVersion)&quot; -Toolset &quot;$(Q1ViewOpenCvToolset)&quot; -InstallRoot &quot;$(Q1ViewOpenCvInstallRoot)&quot; -ArchiveUrl &quot;$(Q1ViewOpenCvArchiveUrl)&quot; -ArchivePath &quot;$(Q1ViewOpenCvArchivePath)&quot; -Sha256 &quot;$(Q1ViewOpenCvSha256)&quot; -Configuration &quot;$(Configuration)&quot; -Platform &quot;$(Platform)&quot; -BinaryPrefix &quot;$(Q1ViewOpenCvBinaryPrefix)&quot;" />
   </Target>
   <Target Name="Q1ViewCopyOpenCvRuntime"
           AfterTargets="Build"

build/Build-OpenCvDependency.ps1

@@ -1,6 +1,8 @@
 param(
     [string]$Version = "4.3.0",
 
+    [string]$Toolset = "v142",
+
     [string]$SourceRoot = "",
 
     [string]$BuildRoot = "",
@@ -160,8 +162,10 @@ $cmake = Get-CMake
 $configureStamp = Join-Path $buildRootPath "CMakeCache.txt"
 if (Test-Path $configureStamp) {
     $cacheText = Get-Content -LiteralPath $configureStamp -Raw
-    if ($cacheText -notmatch "BUILD_WITH_STATIC_CRT:BOOL=ON") {
-        Write-Host "Reconfiguring OpenCV because the existing build tree does not use the static CRT"
+    $toolsetPattern = "CMAKE_GENERATOR_TOOLSET:INTERNAL=$([regex]::Escape($Toolset))(\r?\n|,)"
+    if ($cacheText -notmatch "BUILD_WITH_STATIC_CRT:BOOL=ON" -or
+            $cacheText -notmatch $toolsetPattern) {
+        Write-Host "Reconfiguring OpenCV because the existing build tree does not use $Toolset with the static CRT"
         Remove-Item -LiteralPath $buildRootPath -Recurse -Force
         if (Test-Path $installRootPath) {
             Remove-Item -LiteralPath $installRootPath -Recurse -Force
@@ -177,6 +181,7 @@ if (-not (Test-Path $configureStamp)) {
         "-S", $sourceRootPath,
         "-B", $buildRootPath,
         "-A", $platformName,
+        "-T", $Toolset,
         "-DOpenCV_ARCH=$platformName",
         "-DOpenCV_RUNTIME=vc16",
         "-DCMAKE_INSTALL_PREFIX=$installRootPath",
@@ -239,7 +244,7 @@ foreach ($configuration in $Configurations) {
     }
 
     $stampPath = Join-Path $installRootPath "q1view-opencv-$configuration.stamp"
-    "OpenCV $Version $configuration $platformName static-crt" | Out-File -LiteralPath $stampPath -Encoding ascii
+    "OpenCV $Version $configuration $platformName $Toolset static-crt" | Out-File -LiteralPath $stampPath -Encoding ascii
 }
 
 $ffmpegDllPath = Join-Path $installRootPath "$binaryPrefix\bin\opencv_videoio_ffmpeg430_64.dll"

build/Ensure-OpenCvDependency.ps1

@@ -1,6 +1,8 @@
 param(
     [string]$Version = "4.3.0",
 
+    [string]$Toolset = "v142",
+
     [Parameter(Mandatory = $true)]
     [string]$InstallRoot,
 
@@ -63,7 +65,7 @@ function Get-ArchiveFileName {
     param([string]$Url)
 
     if ([string]::IsNullOrWhiteSpace($Url)) {
-        return "Q1View-opencv-$Version-msvc-x64-static-mt.zip"
+        return "Q1View-opencv-$Version-msvc-$Toolset-x64-static-mt.zip"
     }
 
     try {
@@ -76,7 +78,7 @@ function Get-ArchiveFileName {
     catch {
     }
 
-    return "Q1View-opencv-$Version-msvc-x64-static-mt.zip"
+    return "Q1View-opencv-$Version-msvc-$Toolset-x64-static-mt.zip"
 }
 
 function Resolve-Archive {

docs/DEVELOPMENT.md

@@ -17,8 +17,10 @@ msbuild Comparer\Comparer.sln /m /restore /p:Configuration=Release /p:Platform=x
 ```
 
 Normal builds restore prebuilt OpenCV and libheif dependency archives into
-`.deps`. Dedicated GitHub Actions workflows create updated dependency archives
-when dependency versions change.
+`.deps`. The OpenCV archive is built with the VS2019 `v142` toolset so its
+static libraries link with VS2019 and newer MSVC toolsets. Dedicated GitHub
+Actions workflows create updated dependency archives when dependency versions
+or toolsets change.
 
 ## Core Regression Tests