Update splash screen to be per-monitor DPI aware.

Remove GDI+ from engine since the higher quality scaling isn't worth the additional dependency.

5 files changed, 171 insertions, 128 deletions

diff --git a/src/engine/engine.cpp b/src/engine/engine.cpp
index 71c37138..ae5b690c 100644
--- a/src/engine/engine.cpp
+++ b/src/engine/engine.cpp
@@ -89,6 +89,7 @@ extern "C" HRESULT EngineRun(
     BOOL fComInitialized = FALSE;
     BOOL fLogInitialized = FALSE;
     BOOL fCrypInitialized = FALSE;
+    BOOL fDpiuInitialized = FALSE;
     BOOL fRegInitialized = FALSE;
     BOOL fWiuInitialized = FALSE;
     BOOL fXmlInitialized = FALSE;
@@ -132,6 +133,9 @@ extern "C" HRESULT EngineRun(
     ExitOnFailure(hr, "Failed to initialize Cryputil.");
     fCrypInitialized = TRUE;
 
+    DpiuInitialize();
+    fDpiuInitialized = TRUE;
+
     hr = RegInitialize();
     ExitOnFailure(hr, "Failed to initialize Regutil.");
     fRegInitialized = TRUE;
@@ -241,6 +245,11 @@ LExit:
         RegUninitialize();
     }
 
+    if (fDpiuInitialized)
+    {
+        DpiuUninitialize();
+    }
+
     if (fCrypInitialized)
     {
         CrypUninitialize();
diff --git a/src/engine/engine.vcxproj b/src/engine/engine.vcxproj
index 906792a6..ef5c1602 100644
--- a/src/engine/engine.vcxproj
+++ b/src/engine/engine.vcxproj
@@ -2,7 +2,7 @@
 <!-- Copyright (c) .NET Foundation and contributors. All rights reserved. Licensed under the Microsoft Reciprocal License. See LICENSE.TXT file in the project root for full license information. -->
 
 <Project DefaultTargets="Build" ToolsVersion="15.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
-  <Import Project="..\..\packages\WixToolset.DUtil.4.0.45\build\WixToolset.DUtil.props" Condition="Exists('..\..\packages\WixToolset.DUtil.4.0.45\build\WixToolset.DUtil.props')" />
+  <Import Project="..\..\packages\WixToolset.DUtil.4.0.49\build\WixToolset.DUtil.props" Condition="Exists('..\..\packages\WixToolset.DUtil.4.0.49\build\WixToolset.DUtil.props')" />
 
   <ItemGroup Label="ProjectConfigurations">
     <ProjectConfiguration Include="Debug|Win32">
@@ -165,7 +165,7 @@ rc.exe -fo "$(OutDir)engine.res" "$(IntDir)engine.messages.rc"</Command>
     <PropertyGroup>
       <ErrorText>This project references NuGet package(s) that are missing on this computer. Use NuGet Package Restore to download them.  For more information, see http://go.microsoft.com/fwlink/?LinkID=322105. The missing file is {0}.</ErrorText>
     </PropertyGroup>
-    <Error Condition="!Exists('..\..\packages\WixToolset.DUtil.4.0.45\build\WixToolset.DUtil.props')" Text="$([System.String]::Format('$(ErrorText)', '..\..\packages\WixToolset.DUtil.4.0.45\build\WixToolset.DUtil.props'))" />
+    <Error Condition="!Exists('..\..\packages\WixToolset.DUtil.4.0.49\build\WixToolset.DUtil.props')" Text="$([System.String]::Format('$(ErrorText)', '..\..\packages\WixToolset.DUtil.4.0.49\build\WixToolset.DUtil.props'))" />
     <Error Condition="!Exists('..\..\packages\Nerdbank.GitVersioning.3.1.91\build\Nerdbank.GitVersioning.targets')" Text="$([System.String]::Format('$(ErrorText)', '..\..\packages\Nerdbank.GitVersioning.3.1.91\build\Nerdbank.GitVersioning.targets'))" />
   </Target>
 </Project>
diff --git a/src/engine/packages.config b/src/engine/packages.config
index 04a6553e..e7fa32d0 100644
--- a/src/engine/packages.config
+++ b/src/engine/packages.config
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
   <package id="Nerdbank.GitVersioning" version="3.1.91" targetFramework="native" developmentDependency="true" />
-  <package id="WixToolset.DUtil" version="4.0.45" targetFramework="native" />
+  <package id="WixToolset.DUtil" version="4.0.49" targetFramework="native" />
 </packages>
\ No newline at end of file
diff --git a/src/engine/precomp.h b/src/engine/precomp.h
index c60d7c0e..b5c5e65e 100644
--- a/src/engine/precomp.h
+++ b/src/engine/precomp.h
@@ -6,11 +6,6 @@
 #include <aclapi.h>
 #include <Bits.h>
 
-#pragma warning(push)
-#pragma warning(disable:4458) // declaration of 'xxx' hides class member
-#include <gdiplus.h>
-#pragma warning(pop)
-
 #include <math.h>
 #include <msiquery.h>
 #include <sddl.h>
@@ -37,7 +32,6 @@
 #include <cryputil.h>
 #include <dirutil.h>
 #include <fileutil.h>
-#include <gdiputil.h>
 #include <guidutil.h>
 #include <logutil.h>
 #include <memutil.h>
@@ -60,6 +54,7 @@
 #include <dlutil.h>
 #include <atomutil.h>
 #include <apuputil.h>
+#include <dpiutil.h>
 
 #include "..\WixToolset.BootstrapperCore.Native\inc\BootstrapperEngine.h"
 #include "..\WixToolset.BootstrapperCore.Native\inc\BootstrapperApplication.h"
diff --git a/src/engine/splashscreen.cpp b/src/engine/splashscreen.cpp
index 1f95886a..cad8c88c 100644
--- a/src/engine/splashscreen.cpp
+++ b/src/engine/splashscreen.cpp
@@ -2,8 +2,6 @@
 
 #include "precomp.h"
 
-using namespace Gdiplus;
-
 #define BURN_SPLASHSCREEN_CLASS_WINDOW L"WixBurnSplashScreen"
 #define IDB_SPLASHSCREEN 1
 
@@ -11,14 +9,16 @@ using namespace Gdiplus;
 
 struct SPLASHSCREEN_INFO
 {
-    Bitmap* pBitmap;
-    Point pt;
-    Size size;
+    HBITMAP hBitmap;
+    SIZE defaultDpiSize;
+    SIZE size;
+    UINT nDpi;
+    HWND hWnd;
 };
 
 struct SPLASHSCREEN_CONTEXT
 {
-    HANDLE hIntializedEvent;
+    HANDLE hInitializedEvent;
     HINSTANCE hInstance;
     LPCWSTR wzCaption;
 
@@ -36,14 +36,29 @@ static LRESULT CALLBACK WndProc(
     __in WPARAM wParam,
     __in LPARAM lParam
     );
-static void OnPaint(
-    __in HDC hdc,
-    __in SPLASHSCREEN_INFO* pSplashScreen
-    );
 static HRESULT LoadSplashScreen(
-    __in HMODULE hInstance,
+    __in SPLASHSCREEN_CONTEXT* pContext,
     __in SPLASHSCREEN_INFO* pSplashScreen
     );
+static BOOL OnDpiChanged(
+    __in SPLASHSCREEN_INFO* pSplashScreen,
+    __in WPARAM wParam,
+    __in LPARAM lParam
+    );
+static void OnEraseBkgnd(
+    __in SPLASHSCREEN_INFO* pSplashScreen,
+    __in WPARAM wParam
+    );
+static void OnNcCreate(
+    __in HWND hWnd,
+    __in LPARAM lParam
+    );
+static void ScaleSplashScreen(
+    __in SPLASHSCREEN_INFO* pSplashScreen,
+    __in UINT nDpi,
+    __in int x,
+    __in int y
+    );
 
 
 // function definitions
@@ -63,7 +78,7 @@ extern "C" void SplashScreenCreate(
     ExitOnNullWithLastError(rgSplashScreenEvents[0], hr, "Failed to create modal event.");
 
     // create splash screen thread.
-    context.hIntializedEvent = rgSplashScreenEvents[0];
+    context.hInitializedEvent = rgSplashScreenEvents[0];
     context.hInstance = hInstance;
     context.wzCaption = wzCaption;
     context.pHwnd = pHwnd;
@@ -115,30 +130,17 @@ static DWORD WINAPI ThreadProc(
     )
 {
     HRESULT hr = S_OK;
-
-    ULONG_PTR token = 0;
-    GdiplusStartupInput input;
-    GdiplusStartupOutput output = { };
-
     SPLASHSCREEN_CONTEXT* pContext = static_cast<SPLASHSCREEN_CONTEXT*>(pvContext);
-    SPLASHSCREEN_INFO splashScreen = { };
+
+    SPLASHSCREEN_INFO splashScreenInfo = { };
 
     WNDCLASSW wc = { };
     BOOL fRegistered = TRUE;
-    HWND hWnd = NULL;
 
     BOOL fRet = FALSE;
     MSG msg = { };
 
-    input.GdiplusVersion = 1;
-
-    hr = GdipInitialize(&input, &token, &output);
-    ExitOnFailure(hr, "Failed to initialize GDI+.");
-
-    hr = LoadSplashScreen(pContext->hInstance, &splashScreen);
-    ExitOnFailure(hr, "Failed to load splash screen.");
-
-    // Register the window class and create the window.
+    // Register the window class.
     wc.lpfnWndProc = WndProc;
     wc.hInstance = pContext->hInstance;
     wc.hCursor = ::LoadCursorW(NULL, (LPCWSTR)IDC_ARROW);
@@ -150,12 +152,12 @@ static DWORD WINAPI ThreadProc(
 
     fRegistered = TRUE;
 
-    hWnd = ::CreateWindowExW(WS_EX_TOOLWINDOW, wc.lpszClassName, pContext->wzCaption, WS_POPUP | WS_VISIBLE, splashScreen.pt.X, splashScreen.pt.Y, splashScreen.size.Width, splashScreen.size.Height, HWND_DESKTOP, NULL, pContext->hInstance, &splashScreen);
-    ExitOnNullWithLastError(hWnd, hr, "Failed to create window.");
+    hr = LoadSplashScreen(pContext, &splashScreenInfo);
+    ExitOnFailure(hr, "Failed to load splash screen.");
 
     // Return the splash screen window and free the main thread waiting for us to be initialized.
-    *pContext->pHwnd = hWnd;
-    ::SetEvent(pContext->hIntializedEvent);
+    *pContext->pHwnd = splashScreenInfo.hWnd;
+    ::SetEvent(pContext->hInitializedEvent);
 
     // Pump messages until the bootstrapper application destroys the window.
     while (0 != (fRet = ::GetMessageW(&msg, NULL, 0, 0)))
@@ -165,7 +167,7 @@ static DWORD WINAPI ThreadProc(
             hr = E_UNEXPECTED;
             ExitOnFailure(hr, "Unexpected return value from message pump.");
         }
-        else if (!::IsDialogMessageW(hWnd, &msg))
+        else if (!::IsDialogMessageW(splashScreenInfo.hWnd, &msg))
         {
             ::TranslateMessage(&msg);
             ::DispatchMessageW(&msg);
@@ -178,14 +180,9 @@ LExit:
         ::UnregisterClassW(BURN_SPLASHSCREEN_CLASS_WINDOW, pContext->hInstance);
     }
 
-    if (splashScreen.pBitmap)
-    {
-        delete splashScreen.pBitmap;
-    }
-
-    if (token)
+    if (splashScreenInfo.hBitmap)
     {
-        GdipUninitialize(token);
+        ::DeleteObject(splashScreenInfo.hBitmap);
     }
 
     return hr;
@@ -204,113 +201,155 @@ static LRESULT CALLBACK WndProc(
     switch (uMsg)
     {
     case WM_NCCREATE:
-        {
-        LPCREATESTRUCTW lpcs = reinterpret_cast<LPCREATESTRUCTW>(lParam);
-        ::SetWindowLongPtrW(hWnd, GWLP_USERDATA, reinterpret_cast<LONG_PTR>(lpcs->lpCreateParams));
-        }
+        OnNcCreate(hWnd, lParam);
         break;
 
     case WM_NCDESTROY:
         lres = ::DefWindowProcW(hWnd, uMsg, wParam, lParam);
         ::SetWindowLongPtrW(hWnd, GWLP_USERDATA, 0);
+        ::PostQuitMessage(0);
         return lres;
 
     case WM_NCHITTEST:
         return HTCAPTION; // allow window to be moved by grabbing any pixel.
 
-    case WM_DESTROY:
-        ::PostQuitMessage(0);
-        return 0;
+    case WM_DPICHANGED:
+        if (OnDpiChanged(pSplashScreen, wParam, lParam))
+        {
+            return 0;
+        }
+        break;
 
     case WM_ERASEBKGND:
-        // The splash screen image will be repainted in its entirety.
+        OnEraseBkgnd(pSplashScreen, wParam);
         return 1;
-
-    case WM_PAINT:
-        {
-        PAINTSTRUCT ps = { };
-
-        HDC hdc = BeginPaint(hWnd, &ps);
-        OnPaint(hdc, pSplashScreen);
-        EndPaint(hWnd, &ps);
-        }
-        return 0;
     }
 
     return ::DefWindowProcW(hWnd, uMsg, wParam, lParam);
 }
 
-static void OnPaint(
-    __in HDC hdc,
-    __in SPLASHSCREEN_INFO* pSplashScreen
-    )
-{
-    // Use high-quality bicubuc stretching from GDI+ which looks better than GDI.
-    Graphics graphics(hdc);
-    graphics.SetInterpolationMode(InterpolationModeHighQualityBicubic);
-
-    Rect dst(0, 0, pSplashScreen->size.Width, pSplashScreen->size.Height);
-    Status status = graphics.DrawImage(pSplashScreen->pBitmap, dst);
-
-#if DEBUG
-    HRESULT hr = GdipHresultFromStatus(status);
-    TraceError(hr, "Failed to draw splash screen bitmap.");
-#else
-    UNREFERENCED_PARAMETER(status);
-#endif
-}
-
 static HRESULT LoadSplashScreen(
-    __in HMODULE hInstance,
+    __in SPLASHSCREEN_CONTEXT* pContext,
     __in SPLASHSCREEN_INFO* pSplashScreen
     )
 {
     HRESULT hr = S_OK;
-    POINT ptCursor = { };
-    HMONITOR hMonitor = NULL;
-    MONITORINFOEXW mi;
-    HDC hdc = NULL;
-    UINT dpiX = 0;
-    UINT dpiY = 0;
-
-    pSplashScreen->pBitmap = Bitmap::FromResource(hInstance, MAKEINTRESOURCEW(IDB_SPLASHSCREEN));
-    ExitOnNull(pSplashScreen->pBitmap, hr, E_INVALIDDATA, "Failed to find the splash screen bitmap.");
-    ExitOnGdipFailure(pSplashScreen->pBitmap->GetLastStatus(), hr, "Failed to load the splash screen bitmap.");
-
-    pSplashScreen->pt.X = CW_USEDEFAULT;
-    pSplashScreen->pt.Y = CW_USEDEFAULT;
-    pSplashScreen->size.Width = pSplashScreen->pBitmap->GetWidth();
-    pSplashScreen->size.Height = pSplashScreen->pBitmap->GetHeight();
-
-    // Stretch and center the window on the monitor with the mouse.
-    if (::GetCursorPos(&ptCursor))
+    BITMAP bmp = { };
+    POINT pt = { };
+    int x = 0;
+    int y = 0;
+    DPIU_MONITOR_CONTEXT* pMonitorContext = NULL;
+    RECT* pMonitorRect = NULL;
+
+    pSplashScreen->nDpi = USER_DEFAULT_SCREEN_DPI;
+    pSplashScreen->hBitmap = ::LoadBitmapW(pContext->hInstance, MAKEINTRESOURCEW(IDB_SPLASHSCREEN));
+    ExitOnNullWithLastError(pSplashScreen->hBitmap, hr, "Failed to load splash screen bitmap.");
+
+    ::GetObject(pSplashScreen->hBitmap, sizeof(bmp), static_cast<void*>(&bmp));
+    pSplashScreen->defaultDpiSize.cx = pSplashScreen->size.cx = bmp.bmWidth;
+    pSplashScreen->defaultDpiSize.cy = pSplashScreen->size.cy = bmp.bmHeight;
+
+    // Try to default to the monitor with the mouse, otherwise default to the primary monitor.
+    if (!::GetCursorPos(&pt))
     {
-        hMonitor = ::MonitorFromPoint(ptCursor, MONITOR_DEFAULTTONEAREST);
-        if (hMonitor)
+        pt.x = 0;
+        pt.y = 0;
+    }
+
+    // Try to center the window on the chosen monitor.
+    hr = DpiuGetMonitorContextFromPoint(&pt, &pMonitorContext);
+    if (SUCCEEDED(hr))
+    {
+        pMonitorRect = &pMonitorContext->mi.rcWork;
+        if (pMonitorContext->nDpi != pSplashScreen->nDpi)
         {
-            ZeroMemory(&mi, sizeof(mi));
-            mi.cbSize = sizeof(mi);
-
-            if (::GetMonitorInfoW(hMonitor, &mi))
-            {
-                hdc = ::CreateDCW(L"DISPLAY", mi.szDevice, NULL, NULL);
-                if (hdc)
-                {
-                    dpiX = ::GetDeviceCaps(hdc, LOGPIXELSX);
-                    dpiY = ::GetDeviceCaps(hdc, LOGPIXELSY);
-
-                    pSplashScreen->size.Width = pSplashScreen->size.Width * dpiX / 96;
-                    pSplashScreen->size.Height = pSplashScreen->size.Height * dpiY / 96;
-
-                    ::ReleaseDC(NULL, hdc);
-                }
-
-                pSplashScreen->pt.X = mi.rcWork.left + (mi.rcWork.right  - mi.rcWork.left - pSplashScreen->size.Width) / 2;
-                pSplashScreen->pt.Y = mi.rcWork.top  + (mi.rcWork.bottom - mi.rcWork.top  - pSplashScreen->size.Height) / 2;
-            }
+            ScaleSplashScreen(pSplashScreen, pMonitorContext->nDpi, pMonitorRect->left, pMonitorRect->top);
         }
+
+        x = pMonitorRect->left + (pMonitorRect->right - pMonitorRect->left - pSplashScreen->size.cx) / 2;
+        y = pMonitorRect->top + (pMonitorRect->bottom - pMonitorRect->top - pSplashScreen->size.cy) / 2;
     }
+    else
+    {
+        hr = S_OK;
+        x = CW_USEDEFAULT;
+        y = CW_USEDEFAULT;
+    }
+
+    pSplashScreen->hWnd = ::CreateWindowExW(WS_EX_TOOLWINDOW, BURN_SPLASHSCREEN_CLASS_WINDOW, pContext->wzCaption, WS_POPUP | WS_VISIBLE, x, y, pSplashScreen->size.cx, pSplashScreen->size.cy, HWND_DESKTOP, NULL, pContext->hInstance, pSplashScreen);
+    ExitOnNullWithLastError(pSplashScreen->hWnd, hr, "Failed to create window.");
 
 LExit:
+    MemFree(pMonitorContext);
+
     return hr;
 }
+
+static BOOL OnDpiChanged(
+    __in SPLASHSCREEN_INFO* pSplashScreen,
+    __in WPARAM wParam,
+    __in LPARAM lParam
+    )
+{
+    UINT nDpi = HIWORD(wParam);
+    RECT* pRect = reinterpret_cast<RECT*>(lParam);
+    BOOL fDpiChanged = pSplashScreen->nDpi != nDpi;
+
+    if (fDpiChanged)
+    {
+        ScaleSplashScreen(pSplashScreen, nDpi, pRect->left, pRect->top);
+    }
+
+    return fDpiChanged;
+}
+
+static void OnEraseBkgnd(
+    __in SPLASHSCREEN_INFO* pSplashScreen,
+    __in WPARAM wParam
+    )
+{
+    HDC hdc = reinterpret_cast<HDC>(wParam);
+    HDC hdcMem = ::CreateCompatibleDC(hdc);
+    HBITMAP hDefaultBitmap = static_cast<HBITMAP>(::SelectObject(hdcMem, pSplashScreen->hBitmap));
+    ::StretchBlt(hdc, 0, 0, pSplashScreen->size.cx, pSplashScreen->size.cy, hdcMem, 0, 0, pSplashScreen->defaultDpiSize.cx, pSplashScreen->defaultDpiSize.cy, SRCCOPY);
+    ::SelectObject(hdcMem, hDefaultBitmap);
+    ::DeleteDC(hdcMem);
+}
+
+static void OnNcCreate(
+    __in HWND hWnd,
+    __in LPARAM lParam
+    )
+{
+    DPIU_WINDOW_CONTEXT windowContext = { };
+    CREATESTRUCTW* pCreateStruct = reinterpret_cast<CREATESTRUCTW*>(lParam);
+    SPLASHSCREEN_INFO* pSplashScreen = reinterpret_cast<SPLASHSCREEN_INFO*>(pCreateStruct->lpCreateParams);
+
+    ::SetWindowLongPtrW(hWnd, GWLP_USERDATA, reinterpret_cast<LONG_PTR>(pSplashScreen));
+    pSplashScreen->hWnd = hWnd;
+
+    DpiuGetWindowContext(pSplashScreen->hWnd, &windowContext);
+
+    if (windowContext.nDpi != pSplashScreen->nDpi)
+    {
+        ScaleSplashScreen(pSplashScreen, windowContext.nDpi, pCreateStruct->x, pCreateStruct->y);
+    }
+}
+
+static void ScaleSplashScreen(
+    __in SPLASHSCREEN_INFO* pSplashScreen,
+    __in UINT nDpi,
+    __in int x,
+    __in int y
+    )
+{
+    pSplashScreen->nDpi = nDpi;
+
+    pSplashScreen->size.cx = DpiuScaleValue(pSplashScreen->defaultDpiSize.cx, pSplashScreen->nDpi);
+    pSplashScreen->size.cy = DpiuScaleValue(pSplashScreen->defaultDpiSize.cy, pSplashScreen->nDpi);
+
+    if (pSplashScreen->hWnd)
+    {
+        ::SetWindowPos(pSplashScreen->hWnd, NULL, x, y, pSplashScreen->size.cx, pSplashScreen->size.cy, SWP_NOACTIVATE | SWP_NOZORDER);
+    }
+}