feat: add more methods to WinApiLayer

.gitmodules

@@ -1,3 +1,7 @@
+[submodule "third-party/boost"]
+	path = third-party/boost
+	url = https://github.com/boostorg/boost.git
+	branch = master
 [submodule "third-party/googletest"]
 	path = third-party/googletest
 	url = https://github.com/google/googletest.git

CMakeLists.txt

@@ -15,6 +15,9 @@ if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
  set(CMAKE_BUILD_TYPE "Release" CACHE STRING "Choose the type of build." FORCE)
 endif()
 
+# Add our custom CMake modules to the global path
+list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)
+
 #
 # Project optional configuration
 #

cmake/Boost_DD.cmake

@@ -0,0 +1,28 @@
+#
+# Loads the boost library giving the priority to the system package first, with a fallback
+# to the submodule.
+#
+include_guard(GLOBAL)
+
+find_package(Boost 1.85)
+if(NOT Boost_FOUND)
+ message(STATUS "Boost v1.85.x package not found in system. Falling back to submodule.")
+
+ # Limit boost to the required libraries only
+ set(BOOST_INCLUDE_LIBRARIES
+ algorithm
+ scope
+ uuid)
+ add_subdirectory(${CMAKE_CURRENT_LIST_DIR}/../third-party/boost third-party/boost EXCLUDE_FROM_ALL)
+
+ # Emulate the "find_package" target
+ add_library(Boost::boost INTERFACE IMPORTED)
+
+ file(GLOB BOOST_LIBS CONFIGURE_DEPENDS "${CMAKE_CURRENT_LIST_DIR}/../third-party/boost/libs/*")
+ foreach(lib_path ${BOOST_LIBS})
+ get_filename_component(lib_dir "${lib_path}" NAME)
+ if(TARGET "Boost::${lib_dir}")
+ target_link_libraries(Boost::boost INTERFACE "Boost::${lib_dir}")
+ endif()
+ endforeach()
+endif()

src/windows/CMakeLists.txt

@@ -11,5 +11,8 @@ add_library(${MODULE} ${HEADER_LIST} ${SOURCE_LIST})
 # Provide the includes together with this library
 target_include_directories(${MODULE} PUBLIC include)
 
+# Additional external libraries
+include(Boost_DD)
+
 # Link the additional libraries
-target_link_libraries(${MODULE} PRIVATE libcommon)
+target_link_libraries(${MODULE} PRIVATE libcommon Boost::boost setupapi)

src/windows/include/displaydevice/windows/winapilayer.h

@@ -16,5 +16,21 @@ namespace display_device {
  /** For details @see WinApiLayerInterface::query_display_config */
  [[nodiscard]] std::optional<path_and_mode_data_t>
  query_display_config(query_type_e type) const override;
+
+ /** For details @see WinApiLayerInterface::get_device_id */
+ [[nodiscard]] std::string
+ get_device_id(const DISPLAYCONFIG_PATH_INFO &path) const override;
+
+ /** For details @see WinApiLayerInterface::get_monitor_device_path */
+ [[nodiscard]] std::string
+ get_monitor_device_path(const DISPLAYCONFIG_PATH_INFO &path) const override;
+
+ /** For details @see WinApiLayerInterface::get_friendly_name */
+ [[nodiscard]] std::string
+ get_friendly_name(const DISPLAYCONFIG_PATH_INFO &path) const override;
+
+ /** For details @see WinApiLayerInterface::get_display_name */
+ [[nodiscard]] std::string
+ get_display_name(const DISPLAYCONFIG_PATH_INFO &path) const override;
  };
 } // namespace display_device

src/windows/include/displaydevice/windows/winapilayerinterface.h

@@ -62,5 +62,110 @@ namespace display_device {
  */
  [[nodiscard]] virtual std::optional<path_and_mode_data_t>
  query_display_config(query_type_e type) const = 0;
+
+ /**
+ * @brief Get a stable and persistent device id for the path.
+ *
+ * This function tries to generate a unique id for the path that
+ * is persistent between driver re-installs and physical unplugging and
+ * replugging of the device.
+ *
+ * The best candidate for it could have been a "ContainerID" from the
+ * registry, however it was found to be unstable for the virtual display
+ * (probably because it uses the EDID for the id generation and the current
+ * virtual displays have incomplete EDID information). The "ContainerID"
+ * also does not change if the physical device is plugged into a different
+ * port and seems to be very stable, however because of virtual displays
+ * other solution was used.
+ *
+ * The accepted solution was to use the "InstanceID" and EDID (just to be
+ * on the safe side). "InstanceID" is semi-stable, it has some parts that
+ * change between driver re-installs and it has a part that changes based
+ * on the GPU port that the display is connected to. It is most likely to
+ * be unique, but since the MS documentation is lacking we are also hashing
+ * EDID information (contains serial ids, timestamps and etc. that should
+ * guarantee that identical displays are differentiated like with the
+ * "ContainerID"). Most importantly this information is stable for the virtual
+ * displays.
+ *
+ * After we remove the unstable parts from the "InstanceID" and hash everything
+ * together, we get an id that changes only when you connect the display to
+ * a different GPU port which seems to be acceptable.
+ *
+ * As a fallback we are using a hashed device path, in case the "InstanceID" or
+ * EDID is not available. At least if you don't do driver re-installs often
+ * and change the GPU ports, it will be stable for a while.
+ *
+ * @param path Path to get the device id for.
+ * @returns Device id, or an empty string if it could not be generated.
+ * @see query_display_config on how to get paths from the system.
+ *
+ * EXAMPLES:
+ * ```cpp
+ * DISPLAYCONFIG_PATH_INFO path;
+ * const WinApiLayerInterface* iface = getIface(...);
+ * const std::string device_path = iface->get_device_id(path);
+ * ```
+ */
+ [[nodiscard]] virtual std::string
+ get_device_id(const DISPLAYCONFIG_PATH_INFO &path) const = 0;
+
+ /**
+ * @brief Get a string that represents a path from the adapter to the display target.
+ * @param path Path to get the string for.
+ * @returns String representation, or an empty string if it's not available.
+ * @see query_display_config on how to get paths from the system.
+ * @note In the rest of the code we refer to this string representation simply as the "device path".
+ * It is used as a simple way of grouping related path objects together and removing "bad" paths
+ * that don't have such string representation.
+ *
+ * EXAMPLES:
+ * ```cpp
+ * DISPLAYCONFIG_PATH_INFO path;
+ * const WinApiLayerInterface* iface = getIface(...);
+ * const std::string device_path = iface->get_monitor_device_path(path);
+ * ```
+ */
+ [[nodiscard]] virtual std::string
+ get_monitor_device_path(const DISPLAYCONFIG_PATH_INFO &path) const = 0;
+
+ /**
+ * @brief Get the user friendly name for the path.
+ * @param path Path to get user friendly name for.
+ * @returns User friendly name for the path if available, empty string otherwise.
+ * @see query_display_config on how to get paths from the system.
+ * @note This is usually a monitor name (like "ROG PG279Q") and is most likely taken from EDID.
+ *
+ * EXAMPLES:
+ * ```cpp
+ * DISPLAYCONFIG_PATH_INFO path;
+ * const WinApiLayerInterface* iface = getIface(...);
+ * const std::string friendly_name = iface->get_friendly_name(path);
+ * ```
+ */
+ [[nodiscard]] virtual std::string
+ get_friendly_name(const DISPLAYCONFIG_PATH_INFO &path) const = 0;
+
+ /**
+ * @brief Get the logical display name for the path.
+ *
+ * These are the "\\\\.\\DISPLAY1", "\\\\.\\DISPLAY2" and etc. display names that can
+ * change whenever Windows wants to change them.
+ *
+ * @param path Path to get user display name for.
+ * @returns Display name for the path if available, empty string otherwise.
+ * @see query_display_config on how to get paths from the system.
+ * @note Inactive paths can have these names already assigned to them, even
+ * though they are not even in use! There can also be duplicates.
+ *
+ * EXAMPLES:
+ * ```cpp
+ * DISPLAYCONFIG_PATH_INFO path;
+ * const WinApiLayerInterface* iface = getIface(...);
+ * const std::string display_name = iface->get_display_name(path);
+ * ```
+ */
+ [[nodiscard]] virtual std::string
+ get_display_name(const DISPLAYCONFIG_PATH_INFO &path) const = 0;
  };
 } // namespace display_device

.gitmodules

@@ -1,3 +1,7 @@
+[submodule "third-party/boost"]
+	path = third-party/boost
+	url = https://github.com/boostorg/boost.git
+	branch = master
 [submodule "third-party/googletest"]
 	path = third-party/googletest
 	url = https://github.com/google/googletest.git

CMakeLists.txt

@@ -15,6 +15,9 @@ if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
  set(CMAKE_BUILD_TYPE "Release" CACHE STRING "Choose the type of build." FORCE)
 endif()
 
+# Add our custom CMake modules to the global path
+list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)
+
 #
 # Project optional configuration
 #

cmake/Boost_DD.cmake

@@ -0,0 +1,28 @@
+#
+# Loads the boost library giving the priority to the system package first, with a fallback
+# to the submodule.
+#
+include_guard(GLOBAL)
+
+find_package(Boost 1.85)
+if(NOT Boost_FOUND)
+ message(STATUS "Boost v1.85.x package not found in system. Falling back to submodule.")
+
+ # Limit boost to the required libraries only
+ set(BOOST_INCLUDE_LIBRARIES
+ algorithm
+ scope
+ uuid)
+ add_subdirectory(${CMAKE_CURRENT_LIST_DIR}/../third-party/boost third-party/boost EXCLUDE_FROM_ALL)
+
+ # Emulate the "find_package" target
+ add_library(Boost::boost INTERFACE IMPORTED)
+
+ file(GLOB BOOST_LIBS CONFIGURE_DEPENDS "${CMAKE_CURRENT_LIST_DIR}/../third-party/boost/libs/*")
+ foreach(lib_path ${BOOST_LIBS})
+ get_filename_component(lib_dir "${lib_path}" NAME)
+ if(TARGET "Boost::${lib_dir}")
+ target_link_libraries(Boost::boost INTERFACE "Boost::${lib_dir}")
+ endif()
+ endforeach()
+endif()

src/windows/CMakeLists.txt

@@ -11,5 +11,8 @@ add_library(${MODULE} ${HEADER_LIST} ${SOURCE_LIST})
 # Provide the includes together with this library
 target_include_directories(${MODULE} PUBLIC include)
 
+# Additional external libraries
+include(Boost_DD)
+
 # Link the additional libraries
-target_link_libraries(${MODULE} PRIVATE libcommon)
+target_link_libraries(${MODULE} PRIVATE libcommon Boost::boost setupapi)

src/windows/include/displaydevice/windows/winapilayer.h

@@ -16,5 +16,21 @@ namespace display_device {
  /** For details @see WinApiLayerInterface::query_display_config */
  [[nodiscard]] std::optional<path_and_mode_data_t>
  query_display_config(query_type_e type) const override;
+
+ /** For details @see WinApiLayerInterface::get_device_id */
+ [[nodiscard]] std::string
+ get_device_id(const DISPLAYCONFIG_PATH_INFO &path) const override;
+
+ /** For details @see WinApiLayerInterface::get_monitor_device_path */
+ [[nodiscard]] std::string
+ get_monitor_device_path(const DISPLAYCONFIG_PATH_INFO &path) const override;
+
+ /** For details @see WinApiLayerInterface::get_friendly_name */
+ [[nodiscard]] std::string
+ get_friendly_name(const DISPLAYCONFIG_PATH_INFO &path) const override;
+
+ /** For details @see WinApiLayerInterface::get_display_name */
+ [[nodiscard]] std::string
+ get_display_name(const DISPLAYCONFIG_PATH_INFO &path) const override;
  };
 } // namespace display_device

src/windows/include/displaydevice/windows/winapilayerinterface.h

@@ -62,5 +62,110 @@ namespace display_device {
  */
  [[nodiscard]] virtual std::optional<path_and_mode_data_t>
  query_display_config(query_type_e type) const = 0;
+
+ /**
+ * @brief Get a stable and persistent device id for the path.
+ *
+ * This function tries to generate a unique id for the path that
+ * is persistent between driver re-installs and physical unplugging and
+ * replugging of the device.
+ *
+ * The best candidate for it could have been a "ContainerID" from the
+ * registry, however it was found to be unstable for the virtual display
+ * (probably because it uses the EDID for the id generation and the current
+ * virtual displays have incomplete EDID information). The "ContainerID"
+ * also does not change if the physical device is plugged into a different
+ * port and seems to be very stable, however because of virtual displays
+ * other solution was used.
+ *
+ * The accepted solution was to use the "InstanceID" and EDID (just to be
+ * on the safe side). "InstanceID" is semi-stable, it has some parts that
+ * change between driver re-installs and it has a part that changes based
+ * on the GPU port that the display is connected to. It is most likely to
+ * be unique, but since the MS documentation is lacking we are also hashing
+ * EDID information (contains serial ids, timestamps and etc. that should
+ * guarantee that identical displays are differentiated like with the
+ * "ContainerID"). Most importantly this information is stable for the virtual
+ * displays.
+ *
+ * After we remove the unstable parts from the "InstanceID" and hash everything
+ * together, we get an id that changes only when you connect the display to
+ * a different GPU port which seems to be acceptable.
+ *
+ * As a fallback we are using a hashed device path, in case the "InstanceID" or
+ * EDID is not available. At least if you don't do driver re-installs often
+ * and change the GPU ports, it will be stable for a while.
+ *
+ * @param path Path to get the device id for.
+ * @returns Device id, or an empty string if it could not be generated.
+ * @see query_display_config on how to get paths from the system.
+ *
+ * EXAMPLES:
+ * ```cpp
+ * DISPLAYCONFIG_PATH_INFO path;
+ * const WinApiLayerInterface* iface = getIface(...);
+ * const std::string device_path = iface->get_device_id(path);
+ * ```
+ */
+ [[nodiscard]] virtual std::string
+ get_device_id(const DISPLAYCONFIG_PATH_INFO &path) const = 0;
+
+ /**
+ * @brief Get a string that represents a path from the adapter to the display target.
+ * @param path Path to get the string for.
+ * @returns String representation, or an empty string if it's not available.
+ * @see query_display_config on how to get paths from the system.
+ * @note In the rest of the code we refer to this string representation simply as the "device path".
+ * It is used as a simple way of grouping related path objects together and removing "bad" paths
+ * that don't have such string representation.
+ *
+ * EXAMPLES:
+ * ```cpp
+ * DISPLAYCONFIG_PATH_INFO path;
+ * const WinApiLayerInterface* iface = getIface(...);
+ * const std::string device_path = iface->get_monitor_device_path(path);
+ * ```
+ */
+ [[nodiscard]] virtual std::string
+ get_monitor_device_path(const DISPLAYCONFIG_PATH_INFO &path) const = 0;
+
+ /**
+ * @brief Get the user friendly name for the path.
+ * @param path Path to get user friendly name for.
+ * @returns User friendly name for the path if available, empty string otherwise.
+ * @see query_display_config on how to get paths from the system.
+ * @note This is usually a monitor name (like "ROG PG279Q") and is most likely taken from EDID.
+ *
+ * EXAMPLES:
+ * ```cpp
+ * DISPLAYCONFIG_PATH_INFO path;
+ * const WinApiLayerInterface* iface = getIface(...);
+ * const std::string friendly_name = iface->get_friendly_name(path);
+ * ```
+ */
+ [[nodiscard]] virtual std::string
+ get_friendly_name(const DISPLAYCONFIG_PATH_INFO &path) const = 0;
+
+ /**
+ * @brief Get the logical display name for the path.
+ *
+ * These are the "\\\\.\\DISPLAY1", "\\\\.\\DISPLAY2" and etc. display names that can
+ * change whenever Windows wants to change them.
+ *
+ * @param path Path to get user display name for.
+ * @returns Display name for the path if available, empty string otherwise.
+ * @see query_display_config on how to get paths from the system.
+ * @note Inactive paths can have these names already assigned to them, even
+ * though they are not even in use! There can also be duplicates.
+ *
+ * EXAMPLES:
+ * ```cpp
+ * DISPLAYCONFIG_PATH_INFO path;
+ * const WinApiLayerInterface* iface = getIface(...);
+ * const std::string display_name = iface->get_display_name(path);
+ * ```
+ */
+ [[nodiscard]] virtual std::string
+ get_display_name(const DISPLAYCONFIG_PATH_INFO &path) const = 0;
  };
 } // namespace display_device

.gitmodules

@@ -1,3 +1,7 @@
+[submodule "third-party/boost"]
+	path = third-party/boost
+	url = https://github.com/boostorg/boost.git
+	branch = master
 [submodule "third-party/googletest"]
 	path = third-party/googletest
 	url = https://github.com/google/googletest.git

CMakeLists.txt

@@ -15,6 +15,9 @@ if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
  set(CMAKE_BUILD_TYPE "Release" CACHE STRING "Choose the type of build." FORCE)
 endif()
 
+# Add our custom CMake modules to the global path
+list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)
+
 #
 # Project optional configuration
 #

cmake/Boost_DD.cmake

@@ -0,0 +1,28 @@
+#
+# Loads the boost library giving the priority to the system package first, with a fallback
+# to the submodule.
+#
+include_guard(GLOBAL)
+
+find_package(Boost 1.85)
+if(NOT Boost_FOUND)
+ message(STATUS "Boost v1.85.x package not found in system. Falling back to submodule.")
+
+ # Limit boost to the required libraries only
+ set(BOOST_INCLUDE_LIBRARIES
+ algorithm
+ scope
+ uuid)
+ add_subdirectory(${CMAKE_CURRENT_LIST_DIR}/../third-party/boost third-party/boost EXCLUDE_FROM_ALL)
+
+ # Emulate the "find_package" target
+ add_library(Boost::boost INTERFACE IMPORTED)
+
+ file(GLOB BOOST_LIBS CONFIGURE_DEPENDS "${CMAKE_CURRENT_LIST_DIR}/../third-party/boost/libs/*")
+ foreach(lib_path ${BOOST_LIBS})
+ get_filename_component(lib_dir "${lib_path}" NAME)
+ if(TARGET "Boost::${lib_dir}")
+ target_link_libraries(Boost::boost INTERFACE "Boost::${lib_dir}")
+ endif()
+ endforeach()
+endif()

src/windows/CMakeLists.txt

@@ -11,5 +11,8 @@ add_library(${MODULE} ${HEADER_LIST} ${SOURCE_LIST})
 # Provide the includes together with this library
 target_include_directories(${MODULE} PUBLIC include)
 
+# Additional external libraries
+include(Boost_DD)
+
 # Link the additional libraries
-target_link_libraries(${MODULE} PRIVATE libcommon)
+target_link_libraries(${MODULE} PRIVATE libcommon Boost::boost setupapi)

src/windows/include/displaydevice/windows/winapilayer.h

@@ -16,5 +16,21 @@ namespace display_device {
  /** For details @see WinApiLayerInterface::query_display_config */
  [[nodiscard]] std::optional<path_and_mode_data_t>
  query_display_config(query_type_e type) const override;
+
+ /** For details @see WinApiLayerInterface::get_device_id */
+ [[nodiscard]] std::string
+ get_device_id(const DISPLAYCONFIG_PATH_INFO &path) const override;
+
+ /** For details @see WinApiLayerInterface::get_monitor_device_path */
+ [[nodiscard]] std::string
+ get_monitor_device_path(const DISPLAYCONFIG_PATH_INFO &path) const override;
+
+ /** For details @see WinApiLayerInterface::get_friendly_name */
+ [[nodiscard]] std::string
+ get_friendly_name(const DISPLAYCONFIG_PATH_INFO &path) const override;
+
+ /** For details @see WinApiLayerInterface::get_display_name */
+ [[nodiscard]] std::string
+ get_display_name(const DISPLAYCONFIG_PATH_INFO &path) const override;
  };
 } // namespace display_device

src/windows/include/displaydevice/windows/winapilayerinterface.h

@@ -62,5 +62,110 @@ namespace display_device {
  */
  [[nodiscard]] virtual std::optional<path_and_mode_data_t>
  query_display_config(query_type_e type) const = 0;
+
+ /**
+ * @brief Get a stable and persistent device id for the path.
+ *
+ * This function tries to generate a unique id for the path that
+ * is persistent between driver re-installs and physical unplugging and
+ * replugging of the device.
+ *
+ * The best candidate for it could have been a "ContainerID" from the
+ * registry, however it was found to be unstable for the virtual display
+ * (probably because it uses the EDID for the id generation and the current
+ * virtual displays have incomplete EDID information). The "ContainerID"
+ * also does not change if the physical device is plugged into a different
+ * port and seems to be very stable, however because of virtual displays
+ * other solution was used.
+ *
+ * The accepted solution was to use the "InstanceID" and EDID (just to be
+ * on the safe side). "InstanceID" is semi-stable, it has some parts that
+ * change between driver re-installs and it has a part that changes based
+ * on the GPU port that the display is connected to. It is most likely to
+ * be unique, but since the MS documentation is lacking we are also hashing
+ * EDID information (contains serial ids, timestamps and etc. that should
+ * guarantee that identical displays are differentiated like with the
+ * "ContainerID"). Most importantly this information is stable for the virtual
+ * displays.
+ *
+ * After we remove the unstable parts from the "InstanceID" and hash everything
+ * together, we get an id that changes only when you connect the display to
+ * a different GPU port which seems to be acceptable.
+ *
+ * As a fallback we are using a hashed device path, in case the "InstanceID" or
+ * EDID is not available. At least if you don't do driver re-installs often
+ * and change the GPU ports, it will be stable for a while.
+ *
+ * @param path Path to get the device id for.
+ * @returns Device id, or an empty string if it could not be generated.
+ * @see query_display_config on how to get paths from the system.
+ *
+ * EXAMPLES:
+ * ```cpp
+ * DISPLAYCONFIG_PATH_INFO path;
+ * const WinApiLayerInterface* iface = getIface(...);
+ * const std::string device_path = iface->get_device_id(path);
+ * ```
+ */
+ [[nodiscard]] virtual std::string
+ get_device_id(const DISPLAYCONFIG_PATH_INFO &path) const = 0;
+
+ /**
+ * @brief Get a string that represents a path from the adapter to the display target.
+ * @param path Path to get the string for.
+ * @returns String representation, or an empty string if it's not available.
+ * @see query_display_config on how to get paths from the system.
+ * @note In the rest of the code we refer to this string representation simply as the "device path".
+ * It is used as a simple way of grouping related path objects together and removing "bad" paths
+ * that don't have such string representation.
+ *
+ * EXAMPLES:
+ * ```cpp
+ * DISPLAYCONFIG_PATH_INFO path;
+ * const WinApiLayerInterface* iface = getIface(...);
+ * const std::string device_path = iface->get_monitor_device_path(path);
+ * ```
+ */
+ [[nodiscard]] virtual std::string
+ get_monitor_device_path(const DISPLAYCONFIG_PATH_INFO &path) const = 0;
+
+ /**
+ * @brief Get the user friendly name for the path.
+ * @param path Path to get user friendly name for.
+ * @returns User friendly name for the path if available, empty string otherwise.
+ * @see query_display_config on how to get paths from the system.
+ * @note This is usually a monitor name (like "ROG PG279Q") and is most likely taken from EDID.
+ *
+ * EXAMPLES:
+ * ```cpp
+ * DISPLAYCONFIG_PATH_INFO path;
+ * const WinApiLayerInterface* iface = getIface(...);
+ * const std::string friendly_name = iface->get_friendly_name(path);
+ * ```
+ */
+ [[nodiscard]] virtual std::string
+ get_friendly_name(const DISPLAYCONFIG_PATH_INFO &path) const = 0;
+
+ /**
+ * @brief Get the logical display name for the path.
+ *
+ * These are the "\\\\.\\DISPLAY1", "\\\\.\\DISPLAY2" and etc. display names that can
+ * change whenever Windows wants to change them.
+ *
+ * @param path Path to get user display name for.
+ * @returns Display name for the path if available, empty string otherwise.
+ * @see query_display_config on how to get paths from the system.
+ * @note Inactive paths can have these names already assigned to them, even
+ * though they are not even in use! There can also be duplicates.
+ *
+ * EXAMPLES:
+ * ```cpp
+ * DISPLAYCONFIG_PATH_INFO path;
+ * const WinApiLayerInterface* iface = getIface(...);
+ * const std::string display_name = iface->get_display_name(path);
+ * ```
+ */
+ [[nodiscard]] virtual std::string
+ get_display_name(const DISPLAYCONFIG_PATH_INFO &path) const = 0;
  };
 } // namespace display_device

.gitmodules

@@ -1,3 +1,7 @@
+[submodule "third-party/boost"]
+	path = third-party/boost
+	url = https://github.com/boostorg/boost.git
+	branch = master
 [submodule "third-party/googletest"]
 	path = third-party/googletest
 	url = https://github.com/google/googletest.git

CMakeLists.txt

@@ -15,6 +15,9 @@ if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
  set(CMAKE_BUILD_TYPE "Release" CACHE STRING "Choose the type of build." FORCE)
 endif()
 
+# Add our custom CMake modules to the global path
+list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)
+
 #
 # Project optional configuration
 #

cmake/Boost_DD.cmake

@@ -0,0 +1,28 @@
+#
+# Loads the boost library giving the priority to the system package first, with a fallback
+# to the submodule.
+#
+include_guard(GLOBAL)
+
+find_package(Boost 1.85)
+if(NOT Boost_FOUND)
+ message(STATUS "Boost v1.85.x package not found in system. Falling back to submodule.")
+
+ # Limit boost to the required libraries only
+ set(BOOST_INCLUDE_LIBRARIES
+ algorithm
+ scope
+ uuid)
+ add_subdirectory(${CMAKE_CURRENT_LIST_DIR}/../third-party/boost third-party/boost EXCLUDE_FROM_ALL)
+
+ # Emulate the "find_package" target
+ add_library(Boost::boost INTERFACE IMPORTED)
+
+ file(GLOB BOOST_LIBS CONFIGURE_DEPENDS "${CMAKE_CURRENT_LIST_DIR}/../third-party/boost/libs/*")
+ foreach(lib_path ${BOOST_LIBS})
+ get_filename_component(lib_dir "${lib_path}" NAME)
+ if(TARGET "Boost::${lib_dir}")
+ target_link_libraries(Boost::boost INTERFACE "Boost::${lib_dir}")
+ endif()
+ endforeach()
+endif()

src/windows/CMakeLists.txt

@@ -11,5 +11,8 @@ add_library(${MODULE} ${HEADER_LIST} ${SOURCE_LIST})
 # Provide the includes together with this library
 target_include_directories(${MODULE} PUBLIC include)
 
+# Additional external libraries
+include(Boost_DD)
+
 # Link the additional libraries
-target_link_libraries(${MODULE} PRIVATE libcommon)
+target_link_libraries(${MODULE} PRIVATE libcommon Boost::boost setupapi)

src/windows/include/displaydevice/windows/winapilayer.h

@@ -16,5 +16,21 @@ namespace display_device {
  /** For details @see WinApiLayerInterface::query_display_config */
  [[nodiscard]] std::optional<path_and_mode_data_t>
  query_display_config(query_type_e type) const override;
+
+ /** For details @see WinApiLayerInterface::get_device_id */
+ [[nodiscard]] std::string
+ get_device_id(const DISPLAYCONFIG_PATH_INFO &path) const override;
+
+ /** For details @see WinApiLayerInterface::get_monitor_device_path */
+ [[nodiscard]] std::string
+ get_monitor_device_path(const DISPLAYCONFIG_PATH_INFO &path) const override;
+
+ /** For details @see WinApiLayerInterface::get_friendly_name */
+ [[nodiscard]] std::string
+ get_friendly_name(const DISPLAYCONFIG_PATH_INFO &path) const override;
+
+ /** For details @see WinApiLayerInterface::get_display_name */
+ [[nodiscard]] std::string
+ get_display_name(const DISPLAYCONFIG_PATH_INFO &path) const override;
  };
 } // namespace display_device

src/windows/include/displaydevice/windows/winapilayerinterface.h

@@ -62,5 +62,110 @@ namespace display_device {
  */
  [[nodiscard]] virtual std::optional<path_and_mode_data_t>
  query_display_config(query_type_e type) const = 0;
+
+ /**
+ * @brief Get a stable and persistent device id for the path.
+ *
+ * This function tries to generate a unique id for the path that
+ * is persistent between driver re-installs and physical unplugging and
+ * replugging of the device.
+ *
+ * The best candidate for it could have been a "ContainerID" from the
+ * registry, however it was found to be unstable for the virtual display
+ * (probably because it uses the EDID for the id generation and the current
+ * virtual displays have incomplete EDID information). The "ContainerID"
+ * also does not change if the physical device is plugged into a different
+ * port and seems to be very stable, however because of virtual displays
+ * other solution was used.
+ *
+ * The accepted solution was to use the "InstanceID" and EDID (just to be
+ * on the safe side). "InstanceID" is semi-stable, it has some parts that
+ * change between driver re-installs and it has a part that changes based
+ * on the GPU port that the display is connected to. It is most likely to
+ * be unique, but since the MS documentation is lacking we are also hashing
+ * EDID information (contains serial ids, timestamps and etc. that should
+ * guarantee that identical displays are differentiated like with the
+ * "ContainerID"). Most importantly this information is stable for the virtual
+ * displays.
+ *
+ * After we remove the unstable parts from the "InstanceID" and hash everything
+ * together, we get an id that changes only when you connect the display to
+ * a different GPU port which seems to be acceptable.
+ *
+ * As a fallback we are using a hashed device path, in case the "InstanceID" or
+ * EDID is not available. At least if you don't do driver re-installs often
+ * and change the GPU ports, it will be stable for a while.
+ *
+ * @param path Path to get the device id for.
+ * @returns Device id, or an empty string if it could not be generated.
+ * @see query_display_config on how to get paths from the system.
+ *
+ * EXAMPLES:
+ * ```cpp
+ * DISPLAYCONFIG_PATH_INFO path;
+ * const WinApiLayerInterface* iface = getIface(...);
+ * const std::string device_path = iface->get_device_id(path);
+ * ```
+ */
+ [[nodiscard]] virtual std::string
+ get_device_id(const DISPLAYCONFIG_PATH_INFO &path) const = 0;
+
+ /**
+ * @brief Get a string that represents a path from the adapter to the display target.
+ * @param path Path to get the string for.
+ * @returns String representation, or an empty string if it's not available.
+ * @see query_display_config on how to get paths from the system.
+ * @note In the rest of the code we refer to this string representation simply as the "device path".
+ * It is used as a simple way of grouping related path objects together and removing "bad" paths
+ * that don't have such string representation.
+ *
+ * EXAMPLES:
+ * ```cpp
+ * DISPLAYCONFIG_PATH_INFO path;
+ * const WinApiLayerInterface* iface = getIface(...);
+ * const std::string device_path = iface->get_monitor_device_path(path);
+ * ```
+ */
+ [[nodiscard]] virtual std::string
+ get_monitor_device_path(const DISPLAYCONFIG_PATH_INFO &path) const = 0;
+
+ /**
+ * @brief Get the user friendly name for the path.
+ * @param path Path to get user friendly name for.
+ * @returns User friendly name for the path if available, empty string otherwise.
+ * @see query_display_config on how to get paths from the system.
+ * @note This is usually a monitor name (like "ROG PG279Q") and is most likely taken from EDID.
+ *
+ * EXAMPLES:
+ * ```cpp
+ * DISPLAYCONFIG_PATH_INFO path;
+ * const WinApiLayerInterface* iface = getIface(...);
+ * const std::string friendly_name = iface->get_friendly_name(path);
+ * ```
+ */
+ [[nodiscard]] virtual std::string
+ get_friendly_name(const DISPLAYCONFIG_PATH_INFO &path) const = 0;
+
+ /**
+ * @brief Get the logical display name for the path.
+ *
+ * These are the "\\\\.\\DISPLAY1", "\\\\.\\DISPLAY2" and etc. display names that can
+ * change whenever Windows wants to change them.
+ *
+ * @param path Path to get user display name for.
+ * @returns Display name for the path if available, empty string otherwise.
+ * @see query_display_config on how to get paths from the system.
+ * @note Inactive paths can have these names already assigned to them, even
+ * though they are not even in use! There can also be duplicates.
+ *
+ * EXAMPLES:
+ * ```cpp
+ * DISPLAYCONFIG_PATH_INFO path;
+ * const WinApiLayerInterface* iface = getIface(...);
+ * const std::string display_name = iface->get_display_name(path);
+ * ```
+ */
+ [[nodiscard]] virtual std::string
+ get_display_name(const DISPLAYCONFIG_PATH_INFO &path) const = 0;
  };
 } // namespace display_device

.gitmodules

@@ -1,3 +1,7 @@
+[submodule "third-party/boost"]
+	path = third-party/boost
+	url = https://github.com/boostorg/boost.git
+	branch = master
 [submodule "third-party/googletest"]
 	path = third-party/googletest
 	url = https://github.com/google/googletest.git

CMakeLists.txt

@@ -15,6 +15,9 @@ if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
  set(CMAKE_BUILD_TYPE "Release" CACHE STRING "Choose the type of build." FORCE)
 endif()
 
+# Add our custom CMake modules to the global path
+list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)
+
 #
 # Project optional configuration
 #

cmake/Boost_DD.cmake

@@ -0,0 +1,28 @@
+#
+# Loads the boost library giving the priority to the system package first, with a fallback
+# to the submodule.
+#
+include_guard(GLOBAL)
+
+find_package(Boost 1.85)
+if(NOT Boost_FOUND)
+ message(STATUS "Boost v1.85.x package not found in system. Falling back to submodule.")
+
+ # Limit boost to the required libraries only
+ set(BOOST_INCLUDE_LIBRARIES
+ algorithm
+ scope
+ uuid)
+ add_subdirectory(${CMAKE_CURRENT_LIST_DIR}/../third-party/boost third-party/boost EXCLUDE_FROM_ALL)
+
+ # Emulate the "find_package" target
+ add_library(Boost::boost INTERFACE IMPORTED)
+
+ file(GLOB BOOST_LIBS CONFIGURE_DEPENDS "${CMAKE_CURRENT_LIST_DIR}/../third-party/boost/libs/*")
+ foreach(lib_path ${BOOST_LIBS})
+ get_filename_component(lib_dir "${lib_path}" NAME)
+ if(TARGET "Boost::${lib_dir}")
+ target_link_libraries(Boost::boost INTERFACE "Boost::${lib_dir}")
+ endif()
+ endforeach()
+endif()

src/windows/CMakeLists.txt

@@ -11,5 +11,8 @@ add_library(${MODULE} ${HEADER_LIST} ${SOURCE_LIST})
 # Provide the includes together with this library
 target_include_directories(${MODULE} PUBLIC include)
 
+# Additional external libraries
+include(Boost_DD)
+
 # Link the additional libraries
-target_link_libraries(${MODULE} PRIVATE libcommon)
+target_link_libraries(${MODULE} PRIVATE libcommon Boost::boost setupapi)

src/windows/include/displaydevice/windows/winapilayer.h

@@ -16,5 +16,21 @@ namespace display_device {
  /** For details @see WinApiLayerInterface::query_display_config */
  [[nodiscard]] std::optional<path_and_mode_data_t>
  query_display_config(query_type_e type) const override;
+
+ /** For details @see WinApiLayerInterface::get_device_id */
+ [[nodiscard]] std::string
+ get_device_id(const DISPLAYCONFIG_PATH_INFO &path) const override;
+
+ /** For details @see WinApiLayerInterface::get_monitor_device_path */
+ [[nodiscard]] std::string
+ get_monitor_device_path(const DISPLAYCONFIG_PATH_INFO &path) const override;
+
+ /** For details @see WinApiLayerInterface::get_friendly_name */
+ [[nodiscard]] std::string
+ get_friendly_name(const DISPLAYCONFIG_PATH_INFO &path) const override;
+
+ /** For details @see WinApiLayerInterface::get_display_name */
+ [[nodiscard]] std::string
+ get_display_name(const DISPLAYCONFIG_PATH_INFO &path) const override;
  };
 } // namespace display_device

src/windows/include/displaydevice/windows/winapilayerinterface.h

@@ -62,5 +62,110 @@ namespace display_device {
  */
  [[nodiscard]] virtual std::optional<path_and_mode_data_t>
  query_display_config(query_type_e type) const = 0;
+
+ /**
+ * @brief Get a stable and persistent device id for the path.
+ *
+ * This function tries to generate a unique id for the path that
+ * is persistent between driver re-installs and physical unplugging and
+ * replugging of the device.
+ *
+ * The best candidate for it could have been a "ContainerID" from the
+ * registry, however it was found to be unstable for the virtual display
+ * (probably because it uses the EDID for the id generation and the current
+ * virtual displays have incomplete EDID information). The "ContainerID"
+ * also does not change if the physical device is plugged into a different
+ * port and seems to be very stable, however because of virtual displays
+ * other solution was used.
+ *
+ * The accepted solution was to use the "InstanceID" and EDID (just to be
+ * on the safe side). "InstanceID" is semi-stable, it has some parts that
+ * change between driver re-installs and it has a part that changes based
+ * on the GPU port that the display is connected to. It is most likely to
+ * be unique, but since the MS documentation is lacking we are also hashing
+ * EDID information (contains serial ids, timestamps and etc. that should
+ * guarantee that identical displays are differentiated like with the
+ * "ContainerID"). Most importantly this information is stable for the virtual
+ * displays.
+ *
+ * After we remove the unstable parts from the "InstanceID" and hash everything
+ * together, we get an id that changes only when you connect the display to
+ * a different GPU port which seems to be acceptable.
+ *
+ * As a fallback we are using a hashed device path, in case the "InstanceID" or
+ * EDID is not available. At least if you don't do driver re-installs often
+ * and change the GPU ports, it will be stable for a while.
+ *
+ * @param path Path to get the device id for.
+ * @returns Device id, or an empty string if it could not be generated.
+ * @see query_display_config on how to get paths from the system.
+ *
+ * EXAMPLES:
+ * ```cpp
+ * DISPLAYCONFIG_PATH_INFO path;
+ * const WinApiLayerInterface* iface = getIface(...);
+ * const std::string device_path = iface->get_device_id(path);
+ * ```
+ */
+ [[nodiscard]] virtual std::string
+ get_device_id(const DISPLAYCONFIG_PATH_INFO &path) const = 0;
+
+ /**
+ * @brief Get a string that represents a path from the adapter to the display target.
+ * @param path Path to get the string for.
+ * @returns String representation, or an empty string if it's not available.
+ * @see query_display_config on how to get paths from the system.
+ * @note In the rest of the code we refer to this string representation simply as the "device path".
+ * It is used as a simple way of grouping related path objects together and removing "bad" paths
+ * that don't have such string representation.
+ *
+ * EXAMPLES:
+ * ```cpp
+ * DISPLAYCONFIG_PATH_INFO path;
+ * const WinApiLayerInterface* iface = getIface(...);
+ * const std::string device_path = iface->get_monitor_device_path(path);
+ * ```
+ */
+ [[nodiscard]] virtual std::string
+ get_monitor_device_path(const DISPLAYCONFIG_PATH_INFO &path) const = 0;
+
+ /**
+ * @brief Get the user friendly name for the path.
+ * @param path Path to get user friendly name for.
+ * @returns User friendly name for the path if available, empty string otherwise.
+ * @see query_display_config on how to get paths from the system.
+ * @note This is usually a monitor name (like "ROG PG279Q") and is most likely taken from EDID.
+ *
+ * EXAMPLES:
+ * ```cpp
+ * DISPLAYCONFIG_PATH_INFO path;
+ * const WinApiLayerInterface* iface = getIface(...);
+ * const std::string friendly_name = iface->get_friendly_name(path);
+ * ```
+ */
+ [[nodiscard]] virtual std::string
+ get_friendly_name(const DISPLAYCONFIG_PATH_INFO &path) const = 0;
+
+ /**
+ * @brief Get the logical display name for the path.
+ *
+ * These are the "\\\\.\\DISPLAY1", "\\\\.\\DISPLAY2" and etc. display names that can
+ * change whenever Windows wants to change them.
+ *
+ * @param path Path to get user display name for.
+ * @returns Display name for the path if available, empty string otherwise.
+ * @see query_display_config on how to get paths from the system.
+ * @note Inactive paths can have these names already assigned to them, even
+ * though they are not even in use! There can also be duplicates.
+ *
+ * EXAMPLES:
+ * ```cpp
+ * DISPLAYCONFIG_PATH_INFO path;
+ * const WinApiLayerInterface* iface = getIface(...);
+ * const std::string display_name = iface->get_display_name(path);
+ * ```
+ */
+ [[nodiscard]] virtual std::string
+ get_display_name(const DISPLAYCONFIG_PATH_INFO &path) const = 0;
  };
 } // namespace display_device

.gitmodules

@@ -1,3 +1,7 @@
+[submodule "third-party/boost"]
+	path = third-party/boost
+	url = https://github.com/boostorg/boost.git
+	branch = master
 [submodule "third-party/googletest"]
 	path = third-party/googletest
 	url = https://github.com/google/googletest.git

CMakeLists.txt

@@ -15,6 +15,9 @@ if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
  set(CMAKE_BUILD_TYPE "Release" CACHE STRING "Choose the type of build." FORCE)
 endif()
 
+# Add our custom CMake modules to the global path
+list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)
+
 #
 # Project optional configuration
 #

cmake/Boost_DD.cmake

@@ -0,0 +1,28 @@
+#
+# Loads the boost library giving the priority to the system package first, with a fallback
+# to the submodule.
+#
+include_guard(GLOBAL)
+
+find_package(Boost 1.85)
+if(NOT Boost_FOUND)
+ message(STATUS "Boost v1.85.x package not found in system. Falling back to submodule.")
+
+ # Limit boost to the required libraries only
+ set(BOOST_INCLUDE_LIBRARIES
+ algorithm
+ scope
+ uuid)
+ add_subdirectory(${CMAKE_CURRENT_LIST_DIR}/../third-party/boost third-party/boost EXCLUDE_FROM_ALL)
+
+ # Emulate the "find_package" target
+ add_library(Boost::boost INTERFACE IMPORTED)
+
+ file(GLOB BOOST_LIBS CONFIGURE_DEPENDS "${CMAKE_CURRENT_LIST_DIR}/../third-party/boost/libs/*")
+ foreach(lib_path ${BOOST_LIBS})
+ get_filename_component(lib_dir "${lib_path}" NAME)
+ if(TARGET "Boost::${lib_dir}")
+ target_link_libraries(Boost::boost INTERFACE "Boost::${lib_dir}")
+ endif()
+ endforeach()
+endif()

src/windows/CMakeLists.txt

@@ -11,5 +11,8 @@ add_library(${MODULE} ${HEADER_LIST} ${SOURCE_LIST})
 # Provide the includes together with this library
 target_include_directories(${MODULE} PUBLIC include)
 
+# Additional external libraries
+include(Boost_DD)
+
 # Link the additional libraries
-target_link_libraries(${MODULE} PRIVATE libcommon)
+target_link_libraries(${MODULE} PRIVATE libcommon Boost::boost setupapi)

src/windows/include/displaydevice/windows/winapilayer.h

@@ -16,5 +16,21 @@ namespace display_device {
  /** For details @see WinApiLayerInterface::query_display_config */
  [[nodiscard]] std::optional<path_and_mode_data_t>
  query_display_config(query_type_e type) const override;
+
+ /** For details @see WinApiLayerInterface::get_device_id */
+ [[nodiscard]] std::string
+ get_device_id(const DISPLAYCONFIG_PATH_INFO &path) const override;
+
+ /** For details @see WinApiLayerInterface::get_monitor_device_path */
+ [[nodiscard]] std::string
+ get_monitor_device_path(const DISPLAYCONFIG_PATH_INFO &path) const override;
+
+ /** For details @see WinApiLayerInterface::get_friendly_name */
+ [[nodiscard]] std::string
+ get_friendly_name(const DISPLAYCONFIG_PATH_INFO &path) const override;
+
+ /** For details @see WinApiLayerInterface::get_display_name */
+ [[nodiscard]] std::string
+ get_display_name(const DISPLAYCONFIG_PATH_INFO &path) const override;
  };
 } // namespace display_device

src/windows/include/displaydevice/windows/winapilayerinterface.h

@@ -62,5 +62,110 @@ namespace display_device {
  */
  [[nodiscard]] virtual std::optional<path_and_mode_data_t>
  query_display_config(query_type_e type) const = 0;
+
+ /**
+ * @brief Get a stable and persistent device id for the path.
+ *
+ * This function tries to generate a unique id for the path that
+ * is persistent between driver re-installs and physical unplugging and
+ * replugging of the device.
+ *
+ * The best candidate for it could have been a "ContainerID" from the
+ * registry, however it was found to be unstable for the virtual display
+ * (probably because it uses the EDID for the id generation and the current
+ * virtual displays have incomplete EDID information). The "ContainerID"
+ * also does not change if the physical device is plugged into a different
+ * port and seems to be very stable, however because of virtual displays
+ * other solution was used.
+ *
+ * The accepted solution was to use the "InstanceID" and EDID (just to be
+ * on the safe side). "InstanceID" is semi-stable, it has some parts that
+ * change between driver re-installs and it has a part that changes based
+ * on the GPU port that the display is connected to. It is most likely to
+ * be unique, but since the MS documentation is lacking we are also hashing
+ * EDID information (contains serial ids, timestamps and etc. that should
+ * guarantee that identical displays are differentiated like with the
+ * "ContainerID"). Most importantly this information is stable for the virtual
+ * displays.
+ *
+ * After we remove the unstable parts from the "InstanceID" and hash everything
+ * together, we get an id that changes only when you connect the display to
+ * a different GPU port which seems to be acceptable.
+ *
+ * As a fallback we are using a hashed device path, in case the "InstanceID" or
+ * EDID is not available. At least if you don't do driver re-installs often
+ * and change the GPU ports, it will be stable for a while.
+ *
+ * @param path Path to get the device id for.
+ * @returns Device id, or an empty string if it could not be generated.
+ * @see query_display_config on how to get paths from the system.
+ *
+ * EXAMPLES:
+ * ```cpp
+ * DISPLAYCONFIG_PATH_INFO path;
+ * const WinApiLayerInterface* iface = getIface(...);
+ * const std::string device_path = iface->get_device_id(path);
+ * ```
+ */
+ [[nodiscard]] virtual std::string
+ get_device_id(const DISPLAYCONFIG_PATH_INFO &path) const = 0;
+
+ /**
+ * @brief Get a string that represents a path from the adapter to the display target.
+ * @param path Path to get the string for.
+ * @returns String representation, or an empty string if it's not available.
+ * @see query_display_config on how to get paths from the system.
+ * @note In the rest of the code we refer to this string representation simply as the "device path".
+ * It is used as a simple way of grouping related path objects together and removing "bad" paths
+ * that don't have such string representation.
+ *
+ * EXAMPLES:
+ * ```cpp
+ * DISPLAYCONFIG_PATH_INFO path;
+ * const WinApiLayerInterface* iface = getIface(...);
+ * const std::string device_path = iface->get_monitor_device_path(path);
+ * ```
+ */
+ [[nodiscard]] virtual std::string
+ get_monitor_device_path(const DISPLAYCONFIG_PATH_INFO &path) const = 0;
+
+ /**
+ * @brief Get the user friendly name for the path.
+ * @param path Path to get user friendly name for.
+ * @returns User friendly name for the path if available, empty string otherwise.
+ * @see query_display_config on how to get paths from the system.
+ * @note This is usually a monitor name (like "ROG PG279Q") and is most likely taken from EDID.
+ *
+ * EXAMPLES:
+ * ```cpp
+ * DISPLAYCONFIG_PATH_INFO path;
+ * const WinApiLayerInterface* iface = getIface(...);
+ * const std::string friendly_name = iface->get_friendly_name(path);
+ * ```
+ */
+ [[nodiscard]] virtual std::string
+ get_friendly_name(const DISPLAYCONFIG_PATH_INFO &path) const = 0;
+
+ /**
+ * @brief Get the logical display name for the path.
+ *
+ * These are the "\\\\.\\DISPLAY1", "\\\\.\\DISPLAY2" and etc. display names that can
+ * change whenever Windows wants to change them.
+ *
+ * @param path Path to get user display name for.
+ * @returns Display name for the path if available, empty string otherwise.
+ * @see query_display_config on how to get paths from the system.
+ * @note Inactive paths can have these names already assigned to them, even
+ * though they are not even in use! There can also be duplicates.
+ *
+ * EXAMPLES:
+ * ```cpp
+ * DISPLAYCONFIG_PATH_INFO path;
+ * const WinApiLayerInterface* iface = getIface(...);
+ * const std::string display_name = iface->get_display_name(path);
+ * ```
+ */
+ [[nodiscard]] virtual std::string
+ get_display_name(const DISPLAYCONFIG_PATH_INFO &path) const = 0;
  };
 } // namespace display_device

.gitmodules

@@ -1,3 +1,7 @@
+[submodule "third-party/boost"]
+	path = third-party/boost
+	url = https://github.com/boostorg/boost.git
+	branch = master
 [submodule "third-party/googletest"]
 	path = third-party/googletest
 	url = https://github.com/google/googletest.git

CMakeLists.txt

@@ -15,6 +15,9 @@ if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
  set(CMAKE_BUILD_TYPE "Release" CACHE STRING "Choose the type of build." FORCE)
 endif()
 
+# Add our custom CMake modules to the global path
+list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)
+
 #
 # Project optional configuration
 #

cmake/Boost_DD.cmake

@@ -0,0 +1,28 @@
+#
+# Loads the boost library giving the priority to the system package first, with a fallback
+# to the submodule.
+#
+include_guard(GLOBAL)
+
+find_package(Boost 1.85)
+if(NOT Boost_FOUND)
+ message(STATUS "Boost v1.85.x package not found in system. Falling back to submodule.")
+
+ # Limit boost to the required libraries only
+ set(BOOST_INCLUDE_LIBRARIES
+ algorithm
+ scope
+ uuid)
+ add_subdirectory(${CMAKE_CURRENT_LIST_DIR}/../third-party/boost third-party/boost EXCLUDE_FROM_ALL)
+
+ # Emulate the "find_package" target
+ add_library(Boost::boost INTERFACE IMPORTED)
+
+ file(GLOB BOOST_LIBS CONFIGURE_DEPENDS "${CMAKE_CURRENT_LIST_DIR}/../third-party/boost/libs/*")
+ foreach(lib_path ${BOOST_LIBS})
+ get_filename_component(lib_dir "${lib_path}" NAME)
+ if(TARGET "Boost::${lib_dir}")
+ target_link_libraries(Boost::boost INTERFACE "Boost::${lib_dir}")
+ endif()
+ endforeach()
+endif()

src/windows/CMakeLists.txt

@@ -11,5 +11,8 @@ add_library(${MODULE} ${HEADER_LIST} ${SOURCE_LIST})
 # Provide the includes together with this library
 target_include_directories(${MODULE} PUBLIC include)
 
+# Additional external libraries
+include(Boost_DD)
+
 # Link the additional libraries
-target_link_libraries(${MODULE} PRIVATE libcommon)
+target_link_libraries(${MODULE} PRIVATE libcommon Boost::boost setupapi)

src/windows/include/displaydevice/windows/winapilayer.h

@@ -16,5 +16,21 @@ namespace display_device {
  /** For details @see WinApiLayerInterface::query_display_config */
  [[nodiscard]] std::optional<path_and_mode_data_t>
  query_display_config(query_type_e type) const override;
+
+ /** For details @see WinApiLayerInterface::get_device_id */
+ [[nodiscard]] std::string
+ get_device_id(const DISPLAYCONFIG_PATH_INFO &path) const override;
+
+ /** For details @see WinApiLayerInterface::get_monitor_device_path */
+ [[nodiscard]] std::string
+ get_monitor_device_path(const DISPLAYCONFIG_PATH_INFO &path) const override;
+
+ /** For details @see WinApiLayerInterface::get_friendly_name */
+ [[nodiscard]] std::string
+ get_friendly_name(const DISPLAYCONFIG_PATH_INFO &path) const override;
+
+ /** For details @see WinApiLayerInterface::get_display_name */
+ [[nodiscard]] std::string
+ get_display_name(const DISPLAYCONFIG_PATH_INFO &path) const override;
  };
 } // namespace display_device

src/windows/include/displaydevice/windows/winapilayerinterface.h

@@ -62,5 +62,110 @@ namespace display_device {
  */
  [[nodiscard]] virtual std::optional<path_and_mode_data_t>
  query_display_config(query_type_e type) const = 0;
+
+ /**
+ * @brief Get a stable and persistent device id for the path.
+ *
+ * This function tries to generate a unique id for the path that
+ * is persistent between driver re-installs and physical unplugging and
+ * replugging of the device.
+ *
+ * The best candidate for it could have been a "ContainerID" from the
+ * registry, however it was found to be unstable for the virtual display
+ * (probably because it uses the EDID for the id generation and the current
+ * virtual displays have incomplete EDID information). The "ContainerID"
+ * also does not change if the physical device is plugged into a different
+ * port and seems to be very stable, however because of virtual displays
+ * other solution was used.
+ *
+ * The accepted solution was to use the "InstanceID" and EDID (just to be
+ * on the safe side). "InstanceID" is semi-stable, it has some parts that
+ * change between driver re-installs and it has a part that changes based
+ * on the GPU port that the display is connected to. It is most likely to
+ * be unique, but since the MS documentation is lacking we are also hashing
+ * EDID information (contains serial ids, timestamps and etc. that should
+ * guarantee that identical displays are differentiated like with the
+ * "ContainerID"). Most importantly this information is stable for the virtual
+ * displays.
+ *
+ * After we remove the unstable parts from the "InstanceID" and hash everything
+ * together, we get an id that changes only when you connect the display to
+ * a different GPU port which seems to be acceptable.
+ *
+ * As a fallback we are using a hashed device path, in case the "InstanceID" or
+ * EDID is not available. At least if you don't do driver re-installs often
+ * and change the GPU ports, it will be stable for a while.
+ *
+ * @param path Path to get the device id for.
+ * @returns Device id, or an empty string if it could not be generated.
+ * @see query_display_config on how to get paths from the system.
+ *
+ * EXAMPLES:
+ * ```cpp
+ * DISPLAYCONFIG_PATH_INFO path;
+ * const WinApiLayerInterface* iface = getIface(...);
+ * const std::string device_path = iface->get_device_id(path);
+ * ```
+ */
+ [[nodiscard]] virtual std::string
+ get_device_id(const DISPLAYCONFIG_PATH_INFO &path) const = 0;
+
+ /**
+ * @brief Get a string that represents a path from the adapter to the display target.
+ * @param path Path to get the string for.
+ * @returns String representation, or an empty string if it's not available.
+ * @see query_display_config on how to get paths from the system.
+ * @note In the rest of the code we refer to this string representation simply as the "device path".
+ * It is used as a simple way of grouping related path objects together and removing "bad" paths
+ * that don't have such string representation.
+ *
+ * EXAMPLES:
+ * ```cpp
+ * DISPLAYCONFIG_PATH_INFO path;
+ * const WinApiLayerInterface* iface = getIface(...);
+ * const std::string device_path = iface->get_monitor_device_path(path);
+ * ```
+ */
+ [[nodiscard]] virtual std::string
+ get_monitor_device_path(const DISPLAYCONFIG_PATH_INFO &path) const = 0;
+
+ /**
+ * @brief Get the user friendly name for the path.
+ * @param path Path to get user friendly name for.
+ * @returns User friendly name for the path if available, empty string otherwise.
+ * @see query_display_config on how to get paths from the system.
+ * @note This is usually a monitor name (like "ROG PG279Q") and is most likely taken from EDID.
+ *
+ * EXAMPLES:
+ * ```cpp
+ * DISPLAYCONFIG_PATH_INFO path;
+ * const WinApiLayerInterface* iface = getIface(...);
+ * const std::string friendly_name = iface->get_friendly_name(path);
+ * ```
+ */
+ [[nodiscard]] virtual std::string
+ get_friendly_name(const DISPLAYCONFIG_PATH_INFO &path) const = 0;
+
+ /**
+ * @brief Get the logical display name for the path.
+ *
+ * These are the "\\\\.\\DISPLAY1", "\\\\.\\DISPLAY2" and etc. display names that can
+ * change whenever Windows wants to change them.
+ *
+ * @param path Path to get user display name for.
+ * @returns Display name for the path if available, empty string otherwise.
+ * @see query_display_config on how to get paths from the system.
+ * @note Inactive paths can have these names already assigned to them, even
+ * though they are not even in use! There can also be duplicates.
+ *
+ * EXAMPLES:
+ * ```cpp
+ * DISPLAYCONFIG_PATH_INFO path;
+ * const WinApiLayerInterface* iface = getIface(...);
+ * const std::string display_name = iface->get_display_name(path);
+ * ```
+ */
+ [[nodiscard]] virtual std::string
+ get_display_name(const DISPLAYCONFIG_PATH_INFO &path) const = 0;
  };
 } // namespace display_device

.gitmodules

@@ -1,3 +1,7 @@
+[submodule "third-party/boost"]
+	path = third-party/boost
+	url = https://github.com/boostorg/boost.git
+	branch = master
 [submodule "third-party/googletest"]
 	path = third-party/googletest
 	url = https://github.com/google/googletest.git

CMakeLists.txt

@@ -15,6 +15,9 @@ if(NOT CMAKE_BUILD_TYPE AND NOT CMAKE_CONFIGURATION_TYPES)
  set(CMAKE_BUILD_TYPE "Release" CACHE STRING "Choose the type of build." FORCE)
 endif()
 
+# Add our custom CMake modules to the global path
+list(APPEND CMAKE_MODULE_PATH ${PROJECT_SOURCE_DIR}/cmake)
+
 #
 # Project optional configuration
 #

cmake/Boost_DD.cmake

@@ -0,0 +1,28 @@
+#
+# Loads the boost library giving the priority to the system package first, with a fallback
+# to the submodule.
+#
+include_guard(GLOBAL)
+
+find_package(Boost 1.85)
+if(NOT Boost_FOUND)
+ message(STATUS "Boost v1.85.x package not found in system. Falling back to submodule.")
+
+ # Limit boost to the required libraries only
+ set(BOOST_INCLUDE_LIBRARIES
+ algorithm
+ scope
+ uuid)
+ add_subdirectory(${CMAKE_CURRENT_LIST_DIR}/../third-party/boost third-party/boost EXCLUDE_FROM_ALL)
+
+ # Emulate the "find_package" target
+ add_library(Boost::boost INTERFACE IMPORTED)
+
+ file(GLOB BOOST_LIBS CONFIGURE_DEPENDS "${CMAKE_CURRENT_LIST_DIR}/../third-party/boost/libs/*")
+ foreach(lib_path ${BOOST_LIBS})
+ get_filename_component(lib_dir "${lib_path}" NAME)
+ if(TARGET "Boost::${lib_dir}")
+ target_link_libraries(Boost::boost INTERFACE "Boost::${lib_dir}")
+ endif()
+ endforeach()
+endif()

src/windows/CMakeLists.txt

@@ -11,5 +11,8 @@ add_library(${MODULE} ${HEADER_LIST} ${SOURCE_LIST})
 # Provide the includes together with this library
 target_include_directories(${MODULE} PUBLIC include)
 
+# Additional external libraries
+include(Boost_DD)
+
 # Link the additional libraries
-target_link_libraries(${MODULE} PRIVATE libcommon)
+target_link_libraries(${MODULE} PRIVATE libcommon Boost::boost setupapi)

src/windows/include/displaydevice/windows/winapilayer.h

@@ -16,5 +16,21 @@ namespace display_device {
  /** For details @see WinApiLayerInterface::query_display_config */
  [[nodiscard]] std::optional<path_and_mode_data_t>
  query_display_config(query_type_e type) const override;
+
+ /** For details @see WinApiLayerInterface::get_device_id */
+ [[nodiscard]] std::string
+ get_device_id(const DISPLAYCONFIG_PATH_INFO &path) const override;
+
+ /** For details @see WinApiLayerInterface::get_monitor_device_path */
+ [[nodiscard]] std::string
+ get_monitor_device_path(const DISPLAYCONFIG_PATH_INFO &path) const override;
+
+ /** For details @see WinApiLayerInterface::get_friendly_name */
+ [[nodiscard]] std::string
+ get_friendly_name(const DISPLAYCONFIG_PATH_INFO &path) const override;
+
+ /** For details @see WinApiLayerInterface::get_display_name */
+ [[nodiscard]] std::string
+ get_display_name(const DISPLAYCONFIG_PATH_INFO &path) const override;
  };
 } // namespace display_device

src/windows/include/displaydevice/windows/winapilayerinterface.h

@@ -62,5 +62,110 @@ namespace display_device {
  */
  [[nodiscard]] virtual std::optional<path_and_mode_data_t>
  query_display_config(query_type_e type) const = 0;
+
+ /**
+ * @brief Get a stable and persistent device id for the path.
+ *
+ * This function tries to generate a unique id for the path that
+ * is persistent between driver re-installs and physical unplugging and
+ * replugging of the device.
+ *
+ * The best candidate for it could have been a "ContainerID" from the
+ * registry, however it was found to be unstable for the virtual display
+ * (probably because it uses the EDID for the id generation and the current
+ * virtual displays have incomplete EDID information). The "ContainerID"
+ * also does not change if the physical device is plugged into a different
+ * port and seems to be very stable, however because of virtual displays
+ * other solution was used.
+ *
+ * The accepted solution was to use the "InstanceID" and EDID (just to be
+ * on the safe side). "InstanceID" is semi-stable, it has some parts that
+ * change between driver re-installs and it has a part that changes based
+ * on the GPU port that the display is connected to. It is most likely to
+ * be unique, but since the MS documentation is lacking we are also hashing
+ * EDID information (contains serial ids, timestamps and etc. that should
+ * guarantee that identical displays are differentiated like with the
+ * "ContainerID"). Most importantly this information is stable for the virtual
+ * displays.
+ *
+ * After we remove the unstable parts from the "InstanceID" and hash everything
+ * together, we get an id that changes only when you connect the display to
+ * a different GPU port which seems to be acceptable.
+ *
+ * As a fallback we are using a hashed device path, in case the "InstanceID" or
+ * EDID is not available. At least if you don't do driver re-installs often
+ * and change the GPU ports, it will be stable for a while.
+ *
+ * @param path Path to get the device id for.
+ * @returns Device id, or an empty string if it could not be generated.
+ * @see query_display_config on how to get paths from the system.
+ *
+ * EXAMPLES:
+ * ```cpp
+ * DISPLAYCONFIG_PATH_INFO path;
+ * const WinApiLayerInterface* iface = getIface(...);
+ * const std::string device_path = iface->get_device_id(path);
+ * ```
+ */
+ [[nodiscard]] virtual std::string
+ get_device_id(const DISPLAYCONFIG_PATH_INFO &path) const = 0;
+
+ /**
+ * @brief Get a string that represents a path from the adapter to the display target.
+ * @param path Path to get the string for.
+ * @returns String representation, or an empty string if it's not available.
+ * @see query_display_config on how to get paths from the system.
+ * @note In the rest of the code we refer to this string representation simply as the "device path".
+ * It is used as a simple way of grouping related path objects together and removing "bad" paths
+ * that don't have such string representation.
+ *
+ * EXAMPLES:
+ * ```cpp
+ * DISPLAYCONFIG_PATH_INFO path;
+ * const WinApiLayerInterface* iface = getIface(...);
+ * const std::string device_path = iface->get_monitor_device_path(path);
+ * ```
+ */
+ [[nodiscard]] virtual std::string
+ get_monitor_device_path(const DISPLAYCONFIG_PATH_INFO &path) const = 0;
+
+ /**
+ * @brief Get the user friendly name for the path.
+ * @param path Path to get user friendly name for.
+ * @returns User friendly name for the path if available, empty string otherwise.
+ * @see query_display_config on how to get paths from the system.
+ * @note This is usually a monitor name (like "ROG PG279Q") and is most likely taken from EDID.
+ *
+ * EXAMPLES:
+ * ```cpp
+ * DISPLAYCONFIG_PATH_INFO path;
+ * const WinApiLayerInterface* iface = getIface(...);
+ * const std::string friendly_name = iface->get_friendly_name(path);
+ * ```
+ */
+ [[nodiscard]] virtual std::string
+ get_friendly_name(const DISPLAYCONFIG_PATH_INFO &path) const = 0;
+
+ /**
+ * @brief Get the logical display name for the path.
+ *
+ * These are the "\\\\.\\DISPLAY1", "\\\\.\\DISPLAY2" and etc. display names that can
+ * change whenever Windows wants to change them.
+ *
+ * @param path Path to get user display name for.
+ * @returns Display name for the path if available, empty string otherwise.
+ * @see query_display_config on how to get paths from the system.
+ * @note Inactive paths can have these names already assigned to them, even
+ * though they are not even in use! There can also be duplicates.
+ *
+ * EXAMPLES:
+ * ```cpp
+ * DISPLAYCONFIG_PATH_INFO path;
+ * const WinApiLayerInterface* iface = getIface(...);
+ * const std::string display_name = iface->get_display_name(path);
+ * ```
+ */
+ [[nodiscard]] virtual std::string
+ get_display_name(const DISPLAYCONFIG_PATH_INFO &path) const = 0;
  };
 } // namespace display_device