Skip to content

improve cmakelists.txt for windows platforms #369

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
DichenZhang1 merged 1 commit into from
Sep 5, 2025
Merged

improve cmakelists.txt for windows platforms #369

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 43 additions & 29 deletions CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,12 +15,7 @@
#

cmake_minimum_required(VERSION 3.15)

# CMP0091: MSVC runtime library flags are selected by an abstraction.
# New in CMake 3.15. https://cmake.org/cmake/help/latest/policy/CMP0091.html
if(POLICY CMP0091)
cmake_policy(SET CMP0091 OLD)
endif()
cmake_policy(SET CMP0091 NEW)

set(UHDR_MAJOR_VERSION 1)
set(UHDR_MINOR_VERSION 4)
Expand Down Expand Up @@ -116,21 +111,14 @@ if(NOT IS_MULTI)
endif()
endif()

if(EMSCRIPTEN)
# platform does not support dynamic linking?
message(STATUS "For wasm targets, selecting static only builds")
option(BUILD_SHARED_LIBS "Build shared libraries" FALSE)
elseif(NOT DEFINED BUILD_SHARED_LIBS)
message(STATUS "No target type chosen, selecting Shared")
option(BUILD_SHARED_LIBS "Build shared libraries" TRUE)
endif()

function(option_if_not_defined name description default)
if(NOT DEFINED ${name})
option(${name} ${description} ${default})
endif()
endfunction()

option_if_not_defined(BUILD_SHARED_LIBS "Build and use shared libraries" TRUE)

option_if_not_defined(UHDR_BUILD_EXAMPLES "Build sample application " TRUE)
option_if_not_defined(UHDR_BUILD_TESTS "Build unit tests " FALSE)
option_if_not_defined(UHDR_BUILD_BENCHMARK "Build benchmark tests " FALSE)
Expand All @@ -156,10 +144,6 @@ if(UHDR_BUILD_TESTS AND EMSCRIPTEN)
message(FATAL_ERROR "Building tests not supported for wasm targets")
endif()

if(UHDR_BUILD_BENCHMARK AND WIN32)
message(FATAL_ERROR "Building benchmarks not supported in Windows")
endif()

if(UHDR_BUILD_BENCHMARK AND EMSCRIPTEN)
message(FATAL_ERROR "Building benchmarks not supported for wasm targets")
endif()
Expand Down Expand Up @@ -189,6 +173,19 @@ if(UHDR_BUILD_DEPS AND UHDR_ENABLE_INSTALL)
message(STATUS "Install and uninstall targets - Disabled")
endif()

if(EMSCRIPTEN AND BUILD_SHARED_LIBS)
# platform does not support dynamic linking?
set(BUILD_SHARED_LIBS FALSE)
message(STATUS "For wasm targets, build and use static libraries")
endif()

if(MSVC AND (UHDR_BUILD_DEPS OR UHDR_BUILD_TESTS OR UHDR_BUILD_BENCHMARK) AND BUILD_SHARED_LIBS)
# ExternalProject_Add() for jpeg, gtest, google benchmarks is configured to build static libraries
# to avoid msvc run-time mismatches (/MD vs /MT) during linking, explicitly set BUILD_SHARED_LIBS to STATIC
set(BUILD_SHARED_LIBS FALSE)
message(STATUS "When building dependencies from source, on MSVC, build and use static libraries")
endif()

###########################################################
# Compile flags
###########################################################
Expand All @@ -200,22 +197,25 @@ if(BUILD_SHARED_LIBS)
set(CMAKE_CXX_VISIBILITY_PRESET hidden)
set(CMAKE_VISIBILITY_INLINES_HIDDEN YES)
set(UHDR_ENABLE_STATIC_LINKING OFF)
set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>DLL")
add_compile_options(-DUHDR_BUILDING_SHARED_LIBRARY)
else()
if(WIN32)
set(CMAKE_FIND_LIBRARY_SUFFIXES .lib .a)
set(CMAKE_FIND_LIBRARY_SUFFIXES -static.lib .lib .a)
else()
set(CMAKE_FIND_LIBRARY_SUFFIXES .a)
endif()
if(APPLE)
message(STATUS "Apple does not support statically linking an entire executable, disabling '-static' option")
# Apple does not support statically linking an entire executable
message(STATUS "Pure static executable may not possible, disabling '-static' option")
set(UHDR_ENABLE_STATIC_LINKING OFF)
elseif(DEFINED UHDR_SANITIZE_OPTIONS OR UHDR_BUILD_FUZZERS)
message(STATUS "Possible that sanitizer libraries are only DSO's, disabling '-static' option")
# Sanitizer libraries could be only DSO's, static linking an entire executable not possible
message(STATUS "Pure static executable may not possible, disabling '-static' option")
set(UHDR_ENABLE_STATIC_LINKING OFF)
elseif(MSVC)
message(STATUS "Disabling '-static' option in MSVC platforms")
set(UHDR_ENABLE_STATIC_LINKING OFF)
set(CMAKE_MSVC_RUNTIME_LIBRARY "MultiThreaded$<$<CONFIG:Debug>:Debug>")
set(UHDR_ENABLE_STATIC_LINKING ON)
else()
set(UHDR_ENABLE_STATIC_LINKING ON)
endif()
Expand Down Expand Up @@ -397,6 +397,9 @@ list(APPEND UHDR_CMAKE_ARGS -DCMAKE_CXX_FLAGS_DEBUG=${CMAKE_CXX_FLAGS_DEBUG})
list(APPEND UHDR_CMAKE_ARGS -DCMAKE_CXX_FLAGS_RELEASE=${CMAKE_CXX_FLAGS_RELEASE})
list(APPEND UHDR_CMAKE_ARGS -DCMAKE_CXX_FLAGS_MINSIZEREL=${CMAKE_CXX_FLAGS_MINSIZEREL})
list(APPEND UHDR_CMAKE_ARGS -DCMAKE_CXX_FLAGS_RELWITHDEBINFO=${CMAKE_CXX_FLAGS_RELWITHDEBINFO})
list(APPEND UHDR_CMAKE_ARGS -DCMAKE_MSVC_RUNTIME_LIBRARY=${CMAKE_MSVC_RUNTIME_LIBRARY})
# Build and use static libraries of dependencies
list(APPEND UHDR_CMAKE_ARGS -DBUILD_SHARED_LIBS=OFF)
if(BUILD_SHARED_LIBS)
list(APPEND UHDR_CMAKE_ARGS -DCMAKE_POSITION_INDEPENDENT_CODE=ON)
endif()
Expand Down Expand Up @@ -647,7 +650,8 @@ if(UHDR_BUILD_EXAMPLES)
if(UHDR_BUILD_FUZZERS)
target_link_options(${UHDR_SAMPLE_APP} PRIVATE -fsanitize=fuzzer-no-link)
endif()
if(UHDR_ENABLE_STATIC_LINKING)
if(UHDR_ENABLE_STATIC_LINKING AND NOT MSVC)
# "MSVC_RUNTIME_LIBRARY is set, no need for '-static' option"
target_link_options(${UHDR_SAMPLE_APP} PRIVATE -static)
endif()
target_link_libraries(${UHDR_SAMPLE_APP} PRIVATE ${UHDR_CORE_LIB_NAME})
Expand Down Expand Up @@ -688,6 +692,7 @@ if(UHDR_BUILD_BENCHMARK)
add_executable(ultrahdr_bm ${UHDR_BM_SRCS_LIST})
add_dependencies(ultrahdr_bm ${BM_TARGET_NAME} ${UHDR_CORE_LIB_NAME})
target_compile_options(ultrahdr_bm PRIVATE ${UHDR_WERROR_FLAGS})
target_compile_options(ultrahdr_bm PRIVATE -DBENCHMARK_STATIC_DEFINE)
target_include_directories(ultrahdr_bm PRIVATE
${PRIVATE_INCLUDE_DIR}
${BENCHMARK_INCLUDE_DIR}
Expand All @@ -696,6 +701,10 @@ if(UHDR_BUILD_BENCHMARK)
target_link_options(ultrahdr_bm PRIVATE -fsanitize=fuzzer-no-link)
endif()
target_link_libraries(ultrahdr_bm ${UHDR_CORE_LIB_NAME} ${BENCHMARK_LIBRARIES})
# We need extra libraries on Windows
if(${CMAKE_SYSTEM_NAME} MATCHES "Windows")
target_link_libraries(ultrahdr_bm shlwapi)
endif()

set(RES_FILE "${TESTS_DIR}/data/UltrahdrBenchmarkTestRes-1.2.zip")
set(RES_FILE_MD5SUM "14eac767ef7252051cc5658c4ad776d9")
Expand Down Expand Up @@ -768,7 +777,11 @@ if(UHDR_BUILD_FUZZERS)
target_link_libraries(ultrahdr_legacy_fuzzer ${UHDR_CORE_LIB_NAME})
endif()

set(UHDR_TARGET_NAME uhdr)
if(MSVC AND NOT BUILD_SHARED_LIBS)
set(UHDR_TARGET_NAME uhdr-static)
else()
set(UHDR_TARGET_NAME uhdr)
endif()
add_library(${UHDR_TARGET_NAME})
add_dependencies(${UHDR_TARGET_NAME} ${UHDR_CORE_LIB_NAME})
target_compile_options(${UHDR_TARGET_NAME} PRIVATE ${UHDR_WERROR_FLAGS})
Expand All @@ -788,7 +801,7 @@ endif()
combine_static_libs(${UHDR_CORE_LIB_NAME} ${UHDR_TARGET_NAME})

# Build static library as well
if(BUILD_SHARED_LIBS)
if(BUILD_SHARED_LIBS AND NOT MSVC)
set(UHDR_TARGET_NAME_STATIC uhdr-static)
add_library(${UHDR_TARGET_NAME_STATIC} STATIC)
add_dependencies(${UHDR_TARGET_NAME_STATIC} ${UHDR_CORE_LIB_NAME})
Expand Down Expand Up @@ -819,7 +832,9 @@ if(UHDR_BUILD_JAVA)
endif()

if(UHDR_ENABLE_INSTALL)
if(NOT(MSVC OR XCODE))
# XCODE seems to have issues when the target has only object files as input
# we use combine_static_libs to prepare install targets
if(NOT XCODE)
include(GNUInstallDirs)

# pkg-config: libuhdr.pc
Expand Down Expand Up @@ -856,6 +871,5 @@ if(UHDR_ENABLE_INSTALL)
include(cmake/package.cmake)
include(CPack)
endif()

endif()
endif()
19 changes: 13 additions & 6 deletions docs/building.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,13 +54,13 @@ Following is a list of available options:
| `BUILD_SHARED_LIBS` | ON | See CMake documentation [here](https://cmake.org/cmake/help/latest/variable/BUILD_SHARED_LIBS.html). <ul><li> If `BUILD_SHARED_LIBS` is **OFF**, in the linking phase, static versions of dependencies are chosen. However, the executable targets are not purely static because the system libraries used are still dynamic. </li></ul> |
| `UHDR_BUILD_EXAMPLES` | ON | Build sample application. This application demonstrates how to use [ultrahdr_api.h](../ultrahdr_api.h). |
| `UHDR_BUILD_TESTS` | OFF | Build Unit Tests. Mostly for Devs. During development, different modules of libuhdr library are validated using GoogleTest framework. Developers after making changes to library are expected to run these tests to ensure every thing is functional. |
| `UHDR_BUILD_BENCHMARK` | OFF | Build Benchmark Tests. These are for profiling libuhdr encode/decode API. Resources used by benchmark tests are shared [here](https://storage.googleapis.com/android_media/external/libultrahdr/benchmark/UltrahdrBenchmarkTestRes-1.1.zip). These are downloaded and extracted automatically during the build process for later benchmarking. <ul><li> Benchmark tests are not supported on Windows and this parameter is forced to **OFF** internally while building on **WIN32** platforms. </li></ul>|
| `UHDR_BUILD_BENCHMARK` | OFF | Build Benchmark Tests. These are for profiling libuhdr encode/decode API. Resources used by benchmark tests are shared [here](https://storage.googleapis.com/android_media/external/libultrahdr/benchmark/UltrahdrBenchmarkTestRes-1.1.zip). These are downloaded and extracted automatically during the build process for later benchmarking. |
| `UHDR_BUILD_FUZZERS` | OFF | Build Fuzz Test Applications. Mostly for Devs. <ul><li> Fuzz applications are built by instrumenting the entire software suite. This includes dependency libraries. This is done by forcing `UHDR_BUILD_DEPS` to **ON** internally. </li></ul> |
| `UHDR_BUILD_DEPS` | OFF | Clone and Build project dependencies and not use pre-installed packages. |
| `UHDR_BUILD_JAVA` | OFF | Build JNI wrapper, Java front-end classes and Java sample application. |
| `UHDR_ENABLE_LOGS` | OFF | Build with verbose logging. |
| `UHDR_ENABLE_INSTALL` | ON | Enable install and uninstall targets for libuhdr package. <ul><li> For system wide installation it is best if dependencies are acquired from OS package manager instead of building from source. This is to avoid conflicts with software that is using a different version of the said dependency and also links to libuhdr. So if `UHDR_BUILD_DEPS` is **ON** then `UHDR_ENABLE_INSTALL` is forced to **OFF** internally. |
| `UHDR_ENABLE_INTRINSICS` | ON | Build with SIMD acceleration. Sections of libuhdr are accelerated for Arm Neon architectures and these are enabled. <ul><li> For x86/x86_64 architectures currently no SIMD acceleration is present. Consequently this option has no effect. </li><li> This parameter has no effect no SIMD configuration settings of dependencies. </li></ul> |
| `UHDR_ENABLE_INTRINSICS` | ON | Build with SIMD acceleration. Sections of libuhdr are accelerated for Arm Neon architectures and these are enabled. <ul><li> For x86/x86_64 architectures currently no SIMD acceleration is present. Consequently this option has no effect. </li><li> This parameter has no effect on SIMD configuration settings of dependencies. </li></ul> |
| `UHDR_ENABLE_GLES` | OFF | Build with GPU acceleration. |
| `UHDR_ENABLE_WERROR` | OFF | Enable -Werror when building. |
| `UHDR_MAX_DIMENSION` | 8192 | Maximum dimension supported by the library. The library defaults to handling images upto resolution 8192x8192. For different resolution needs use this option. For example, `-DUHDR_MAX_DIMENSION=4096`. |
Expand Down Expand Up @@ -190,12 +190,21 @@ This will generate the following files under `build_directory`:

### Windows Platform - MSVC Env

Install the prerequisite packages before building:

```sh
git clone https://github.com/libjpeg-turbo/libjpeg-turbo.git
cd libjpeg-turbo
cmake -G "Visual Studio 16 2019" -DCMAKE_INSTALL_PREFIX=/c/msvcinstalls/ -S. -Bbuild
cmake --build ./build --config=Release --target install
```

#### IDE

Compile and Test:

```sh
cmake -G "Visual Studio 16 2019" -DUHDR_BUILD_DEPS=1 -DUHDR_BUILD_TESTS=1 ../
cmake -G "Visual Studio 16 2019" -DCMAKE_PREFIX_PATH=/c/msvcinstalls/ -DCMAKE_INSTALL_PREFIX=/c/msvcinstalls/ ../
cmake --build ./ --config=Release
ctest -C Release
```
Expand All @@ -205,7 +214,7 @@ ctest -C Release
Compile and Test:

```sh
cmake -G "NMake Makefiles" -DUHDR_BUILD_DEPS=1 -DUHDR_BUILD_TESTS=1 ../
cmake -G "NMake Makefiles" -DCMAKE_PREFIX_PATH=/c/msvcinstalls/ -DCMAKE_INSTALL_PREFIX=/c/msvcinstalls/ ../
cmake --build ./
ctest
```
Expand All @@ -214,9 +223,7 @@ This will generate the following files under `build_directory`:

**uhdr.dll** - Shared library for the libuhdr API <br>
**uhdr.lib** - Import library for the libuhdr API <br>
**uhdr-static.lib** - Static link library for the libuhdr API <br>
**ultrahdr_app** - sample application <br>
**ultrahdr_unit_test** - unit tests <br>

### Cross-Compilation - Build System Linux

Expand Down
Loading