Port from main to RB-2.1 - Backport improved "OpenImageIO" dependency management. (#1610)

* Backport ec50ccb from @hodoulp

Signed-off-by: Thomas Mansencal <[email protected]>

* Implement code review changes

Signed-off-by: Thomas Mansencal <[email protected]>

Author: KelSolaar

CMakeLists.txt

@@ -147,6 +147,7 @@ option(OCIO_USE_WINDOWS_UNICODE "On Windows only, compile with Unicode support"
 
 option(OCIO_USE_SSE "Specify whether to enable SSE CPU performance optimizations" ON)
 option(OCIO_USE_OPENEXR_HALF "Specify whether to use an OpenEXR/IlmBase install of the Half library (<=v2.5) instead of the newer Imath library (>=v3.0)" OFF)
+option(OCIO_USE_OIIO_CMAKE_CONFIG "Specify whether to look for OIIO using the generated CMake Config script instead of the custom FindOpenImageIO.cmake script" OFF)
 
 
 ###############################################################################
@@ -261,13 +262,6 @@ include(FindExtPackages)
 ###############################################################################
 # Progress to other sources
 
-# The presence of OpenImageIO allows additional ocio apps and the OSL translation unit tests
-# to be built.
-
-# OpenImageIO
-# https://github.com/OpenImageIO/oiio
-find_package(OpenImageIO 2.1.9)
-
 add_subdirectory(vendor)
 if(OCIO_BUILD_DOCS)
 	add_subdirectory(docs)

share/cmake/modules/FindExtPackages.cmake

@@ -103,3 +103,39 @@ if(OCIO_BUILD_PYTHON OR OCIO_BUILD_DOCS)
         find_package(pybind11 2.6.1 REQUIRED)
     endif()
 endif()
+
+# The presence of OpenImageIO allows additional OCIO apps and the OSL
+# translation unit tests to be built.
+
+if(OCIO_BUILD_APPS OR OCIO_BUILD_TESTS)
+    # OpenImageIO
+    # https://github.com/OpenImageIO/oiio
+
+    set(OIIO_VERSION "2.1.9")
+
+    if(OCIO_USE_OIIO_CMAKE_CONFIG)
+        find_package(OpenImageIO ${OIIO_VERSION} CONFIG)
+    else()
+        find_package(OpenImageIO ${OIIO_VERSION})
+    endif()
+endif()
+
+# Check dependencies for OSL unit test framework (i.e. OpenImageIO and Imath) before looking
+# for the Open Shading Language library.
+
+if(OCIO_BUILD_TESTS)
+    if(TARGET OpenImageIO::OpenImageIO)
+        if(TARGET Imath::Imath)
+            # OpenShadingLanguage
+            # https://github.com/AcademySoftwareFoundation/OpenShadingLanguage
+            find_package(OpenShadingLanguage 1.11)
+            if(NOT OSL_FOUND)
+                message(WARNING "Could NOT find OpenShadingLanguage. Skipping build of the OSL unit tests.")
+            endif()
+        else()
+            message(WARNING "Could NOT find Imath. Skipping build of the OSL unit tests.")
+        endif()
+    else()
+        message(WARNING "Could NOT find OpenImageIO. Skipping build of the OSL unit tests.")
+    endif()
+endif()

share/cmake/utils/CheckSupportGL.cmake

@@ -7,7 +7,7 @@
 
 include(PackageUtils)
 
-if(OCIO_BUILD_GPU_TESTS OR OCIO_BUILD_APPS)
+if((OCIO_BUILD_TESTS AND OCIO_BUILD_GPU_TESTS) OR OCIO_BUILD_APPS)
     set(OCIO_GL_ENABLED ON)
     set(OCIO_USE_GLVND OFF)
     set(OCIO_EGL_HEADLESS OFF)

src/apps/CMakeLists.txt

@@ -14,6 +14,8 @@ if(OCIO_BUILD_APPS)
 		add_subdirectory(ociodisplay)
 		add_subdirectory(ocioperf)
 	else()
-		message(WARNING "Could NOT find OpenImageIO. Skipping build for ociolutimage, ocioconvert, ociodisplay and ocioperf")
+		message(WARNING "Could NOT find OpenImageIO. Skipping build for ociolutimage, ocioconvert, ociodisplay and ocioperf.")
 	endif()
-endif()
+else()
+	message(WARNING "Skipping build of all apps.")
+endif()

tests/CMakeLists.txt

@@ -1,7 +1,7 @@
 # SPDX-License-Identifier: BSD-3-Clause
 # Copyright Contributors to the OpenColorIO Project.
 
-if(OCIO_BUILD_TESTS OR OCIO_BUILD_GPU_TESTS OR OCIO_BUILD_PYTHON)
+if(OCIO_BUILD_TESTS OR OCIO_BUILD_PYTHON)
     # Copy test files if used.
     add_subdirectory(data)
 endif()
@@ -12,27 +12,16 @@ if(OCIO_BUILD_TESTS)
     add_subdirectory(utils)
     add_subdirectory(cpu)
     add_subdirectory(cmake-consumer)
-endif()
 
-if(OCIO_BUILD_GPU_TESTS)
-    add_subdirectory(gpu)
-endif()
+    if(OCIO_BUILD_GPU_TESTS)
+        add_subdirectory(gpu)
+    endif()
 
-if(OpenImageIO_FOUND AND TARGET OpenImageIO::OpenImageIO)
-    if(TARGET Imath::Imath)
-        # OpenShadingLanguage
-        # https://github.com/AcademySoftwareFoundation/OpenShadingLanguage
-        find_package(OpenShadingLanguage 1.11)
-        if(OSL_FOUND)
-            add_subdirectory(osl)
-        else()
-            message(WARNING "Could NOT find OpenShadingLanguage. Skipping build of the OSL unit tests")
-        endif()
-    else()
-        message(WARNING "Could NOT find Imath. Skipping build of the OSL unit tests")
+    if(OSL_FOUND)
+        add_subdirectory(osl)
     endif()
 else()
-    message(WARNING "Could NOT find OpenImageIO. Skipping build of the OSL unit tests")
+    message(WARNING "Skipping the library unit tests.")
 endif()
 
 if(OCIO_BUILD_JAVA)
@@ -41,4 +30,4 @@ endif()
 
 if(OCIO_BUILD_PYTHON)
     add_subdirectory(python)
-endif()
+endif()

tests/osl/CMakeLists.txt

@@ -35,6 +35,9 @@ endif(OCIO_USE_SSE)
 set_target_properties(test_osl_exec PROPERTIES 
     COMPILE_FLAGS "${PLATFORM_COMPILE_FLAGS}")
 
+# Because some OpenImageIO types are present in the OSL public API that dependency is mandatory;
+# however, the unit test framework itself does not have any OpenImageIO dependency.
+
 target_link_libraries(test_osl_exec
     PRIVATE
         OpenColorIO
@@ -63,4 +66,4 @@ if(MSVC AND BUILD_SHARED_LIBS)
 
     set_tests_properties(test_osl PROPERTIES ENVIRONMENT PATH=${NEW_PATH})
 
-endif()
+endif()