Merge branch 'main' into otime_doxygen

Author: darbyjohnston

CMakeLists.txt

@@ -34,6 +34,7 @@ option(OTIO_INSTALL_COMMANDLINE_TOOLS "Install the OTIO command line tools" ON)
 option(OTIO_INSTALL_CONTRIB           "Install the opentimelineio_contrib Python package" ON)
 set(OTIO_IMATH_LIBS "" CACHE STRING   "Imath library overrides to use instead of src/deps or find_package")
 option(OTIO_FIND_IMATH                "Find Imath using find_package, ignored if OTIO_IMATH_LIBS is set" OFF)
+option(OTIO_FIND_RAPIDJSON            "Find RapidJSON using find_package" OFF)
 set(OTIO_PYTHON_INSTALL_DIR "" CACHE STRING "Python installation dir (such as the site-packages dir)")
 
 # Build options
@@ -118,6 +119,31 @@ else()
     endif()
 endif()
 
+# Set the SO version. The SO version must be incremented every time a change
+# occurs to the ABI that causes a backward incompatibility. Such changes
+# include, exhaustively:
+#
+# * a change to struct or class layout
+# * enum changes that would cause a renumbering of previously published enums
+# * a removal of a struct, class, enumeration, or function
+# * a change in parameters to a free standing function
+# * a removal of a global variable
+#
+# OTIO currently designates the minor version number for breaking changes,
+# e.g. v0.15, v0.16.0, v0.17.0, accordingly the SO version will be incremented
+# to match. SO version must be monotically increasing, so the ABI version
+# should be computed as: major * 100 + revision. The third digit will never
+# implicate an ABI version change. So for example, the following OTIO versions
+# would map to these ABI versions:
+#
+# * v0.18.0 - 18
+# * v0.19.0 - 19
+# * v0.19.1 - 19 # No ABI changes with minor version changes
+# * v1.0.0 - 100
+# * v1.1.0 - 101
+#
+math(EXPR OTIO_SOVERSION "${OTIO_VERSION_MAJOR} * 100 + ${OTIO_VERSION_MINOR}")
+
 set(OTIO_RESOLVED_CXX_INSTALL_DIR "${CMAKE_INSTALL_PREFIX}")
 
 if(OTIO_CXX_INSTALL)
@@ -223,13 +249,10 @@ if (NOT "${OTIO_IMATH_LIBS}" STREQUAL "")
     set(OTIO_RESOLVED_IMATH_LIBRARIES "${OTIO_IMATH_LIBS}")
     set(USE_DEPS_IMATH OFF)
 elseif(OTIO_FIND_IMATH)
-    find_package(Imath QUIET)
+    set(USE_DEPS_IMATH OFF)
+    find_package(Imath REQUIRED)
     if (Imath_FOUND)
         message(STATUS "Found Imath 3 at ${Imath_CONFIG}")
-        set(USE_DEPS_IMATH OFF)
-    else()
-        message(STATUS "Imath 3 was not found, using src/deps/Imath")
-        set(USE_DEPS_IMATH ON)
     endif()
 else()
     message(STATUS "Using src/deps/Imath by default")
@@ -240,6 +263,17 @@ if(USE_DEPS_IMATH)
     include_directories("${PROJECT_SOURCE_DIR}/src/deps/Imath/src")
 endif()
 
+#----- RapidJSON
+
+if(OTIO_FIND_RAPIDJSON)
+    find_package(RapidJSON CONFIG REQUIRED)
+    if (RapidJSON_FOUND)
+        message(STATUS "Found RapidJSON at ${RapidJSON_CONFIG}")
+    endif()
+else()
+    message(STATUS "Using src/deps/rapidjson by default")
+endif()
+
 # set up the internally hosted dependencies
 add_subdirectory(src/deps)
 

README.md

@@ -106,16 +106,12 @@ namespace otio = opentimelineio::OPENTIMELINEIO_VERSION;
 void
 main()
 {
-    otio::ErrorStatus err;
     otio::SerializableObject::Retainer<otio::Timeline> tl(
             dynamic_cast<otio::Timeline*>(
-                otio::Timeline::from_json_file("taco.otio", &err)
+                otio::Timeline::from_json_file("taco.otio")
         )
     );
-    const std::vector<otio::SerializableObject::Retainer<otio::Clip>> clips = (
-            tl->find_clips()
-    );
-    for (const auto& cl : clips)
+    for (const auto& cl : tl->find_clips())
     {
         otio::RationalTime dur = cl->duration();
         std::cout << "Name: " << cl->name() << " [";

src/deps/CMakeLists.txt

@@ -4,7 +4,12 @@
 #----- Other dependencies
 
 # detect if the submodules haven't been updated
-set(DEPS_SUBMODULES pybind11 rapidjson)
+set(DEPS_SUBMODULES pybind11)
+
+if(NOT OTIO_FIND_RAPIDJSON)
+    set(DEPS_SUBMODULES ${DEPS_SUBMODULES} rapidjson)
+endif()
+
 foreach(submodule IN LISTS DEPS_SUBMODULES)
     file(GLOB SUBMOD_CONTENTS ${submodule})
     list(LENGTH SUBMOD_CONTENTS SUBMOD_CONTENT_LEN)

src/opentime/CMakeLists.txt

@@ -24,6 +24,12 @@ set_target_properties(opentime PROPERTIES
     POSITION_INDEPENDENT_CODE TRUE
     WINDOWS_EXPORT_ALL_SYMBOLS true)
 
+if(BUILD_SHARED_LIBS)
+    set_target_properties(opentime PROPERTIES
+        SOVERSION ${OTIO_SOVERSION}
+        VERSION ${OTIO_VERSION})
+endif()
+
 if(APPLE)
     set_target_properties(opentime PROPERTIES 
         INSTALL_NAME_DIR "@loader_path"

src/opentimelineio/CMakeLists.txt

@@ -78,9 +78,15 @@ add_library(opentimelineio ${OTIO_SHARED_OR_STATIC_LIB}
 add_library(OTIO::opentimelineio ALIAS opentimelineio)
 
 target_include_directories(opentimelineio
-    PRIVATE       "${PROJECT_SOURCE_DIR}/src"
-                  "${PROJECT_SOURCE_DIR}/src/deps"
-                  "${PROJECT_SOURCE_DIR}/src/deps/rapidjson/include")
+    PRIVATE "${PROJECT_SOURCE_DIR}/src")
+
+if(OTIO_FIND_RAPIDJSON)
+    target_include_directories(opentimelineio
+        PRIVATE "${RapidJSON_INCLUDE_DIRS}")
+else()
+    target_include_directories(opentimelineio
+        PRIVATE "${PROJECT_SOURCE_DIR}/src/deps/rapidjson/include")
+endif()
 
 
 target_link_libraries(opentimelineio 
@@ -92,6 +98,12 @@ set_target_properties(opentimelineio PROPERTIES
     POSITION_INDEPENDENT_CODE TRUE
     WINDOWS_EXPORT_ALL_SYMBOLS true)
 
+if(BUILD_SHARED_LIBS)
+    set_target_properties(opentimelineio PROPERTIES
+        SOVERSION ${OTIO_SOVERSION}
+        VERSION ${OTIO_VERSION})
+endif()
+
 if(APPLE)
     set_target_properties(opentimelineio PROPERTIES 
         INSTALL_NAME_DIR "@loader_path"

src/opentimelineio/serialization.cpp

@@ -77,6 +77,7 @@ class Encoder
     virtual void write_value(class TimeTransform const& value)       = 0;
     virtual void write_value(struct SerializableObject::ReferenceId) = 0;
     virtual void write_value(IMATH_NAMESPACE::Box2d const&)          = 0;
+    virtual void write_value(IMATH_NAMESPACE::V2d const&)            = 0;
 
 protected:
     void _error(ErrorStatus const& error_status)
@@ -269,7 +270,7 @@ class CloningEncoder : public Encoder
         _store(std::any(value));
     }
 
-    void write_value(IMATH_NAMESPACE::V2d const& value)
+    void write_value(IMATH_NAMESPACE::V2d const& value) override
     {
 
         if (_result_object_policy == ResultObjectPolicy::OnlyAnyDictionary)

src/py-opentimelineio/opentimelineio/url_utils.py

@@ -77,7 +77,11 @@ def filepath_from_url(urlstr):
         filepath = pathlib.PurePosixPath(filepath.drive, *filepath.parts[1:])
 
     # If the specified index is a windows drive, then offset the path
-    elif pathlib.PureWindowsPath(filepath.parts[1]).drive:
+    elif (
+        # relative paths may not have a parts[1]
+        len(filepath.parts) > 1
+        and pathlib.PureWindowsPath(filepath.parts[1]).drive
+    ):
         # Remove leading "/" if/when `request.url2pathname` yields
         # "/S:/path/file.ext"
         filepath = pathlib.PurePosixPath(*filepath.parts[1:])

tests/test_url_conversions.py

@@ -79,6 +79,14 @@ def test_posix_urls(self):
             processed_url = otio.url_utils.filepath_from_url(url)
             self.assertEqual(processed_url, POSIX_PATH)
 
+    def test_relative_url(self):
+        # see github issue #1817 - when a relative URL has only one name after
+        # the "." (ie ./blah but not ./blah/blah)
+        self.assertEqual(
+            otio.url_utils.filepath_from_url(os.path.join(".", "docs")),
+            "docs",
+        )
+
 
 if __name__ == "__main__":
     unittest.main()

tests/test_v2d.py

@@ -1,12 +1,14 @@
 # SPDX-License-Identifier: Apache-2.0
 # Copyright Contributors to the OpenTimelineIO project
 
-import unittest
+import json
 import sys
+import unittest
 
-import opentimelineio as otio
 import opentimelineio.test_utils as otio_test_utils
 
+import opentimelineio as otio
+
 
 class V2dTests(unittest.TestCase, otio_test_utils.OTIOAssertions):
     def test_cons(self):
@@ -21,15 +23,9 @@ def test_cons(self):
     def test_str(self):
         v = otio.schema.V2d(1.0, 2.0)
 
-        self.assertMultiLineEqual(
-            str(v),
-            'V2d(1.0, 2.0)'
-        )
+        self.assertMultiLineEqual(str(v), "V2d(1.0, 2.0)")
 
-        self.assertMultiLineEqual(
-            repr(v),
-            'otio.schema.V2d(x=1.0, y=2.0)'
-        )
+        self.assertMultiLineEqual(repr(v), "otio.schema.V2d(x=1.0, y=2.0)")
 
     def test_equality(self):
         v1 = otio.schema.V2d(1.0, 2.0)
@@ -104,6 +100,17 @@ def test_limits(self):
         self.assertEqual(otio.schema.V2d.baseTypeSmallest(), sys.float_info.min)
         self.assertEqual(otio.schema.V2d.baseTypeEpsilon(), sys.float_info.epsilon)
 
+    def test_json_serialization(self):
+        serialized = otio.adapters.otio_json.write_to_string(otio.schema.V2d())
+        json_v2d = json.loads(serialized)
+        self.assertEqual(json_v2d["OTIO_SCHEMA"], "V2d.1")
+
+    def test_serialization_round_trip(self):
+        v2d = otio.schema.V2d()
+        serialized = otio.adapters.otio_json.write_to_string(v2d)
+        deserialized = otio.adapters.otio_json.read_from_string(serialized)
+        self.assertEqual(v2d, deserialized)
+
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     unittest.main()