Merge branch 'main' into feature/stream_channel_mapping_support

Author: reinecke

CMakeLists.txt

@@ -1,14 +1,20 @@
 # FindPython's Development.Module component was added in 3.18.
 # Require 3.18.2+ because pybind11 recommends it.
 cmake_minimum_required(VERSION 3.18.2)
+# This policy CMP0177 can be removed when we upgrade to CMake >= 3.31.
+cmake_policy(SET CMP0177 NEW)
 
 #------------------------------------------------------------------------------
 # Project Metadata
 # TODO: read this information from a configuration file, here, and in setup.py
 
-set(OTIO_VERSION_MAJOR "0")
-set(OTIO_VERSION_MINOR "19")
-set(OTIO_VERSION_PATCH "0")
+file(READ "src/opentimelineio/version.h" VERSION_H)
+string(REGEX MATCH "VERSION_MAJOR ([0-9]*)" _ ${VERSION_H})
+set(OTIO_VERSION_MAJOR ${CMAKE_MATCH_1})
+string(REGEX MATCH "VERSION_MINOR ([0-9]*)" _ ${VERSION_H})
+set(OTIO_VERSION_MINOR ${CMAKE_MATCH_1})
+string(REGEX MATCH "VERSION_PATCH ([0-9]*)" _ ${VERSION_H})
+set(OTIO_VERSION_PATCH ${CMAKE_MATCH_1})
 set(OTIO_VERSION ${OTIO_VERSION_MAJOR}.${OTIO_VERSION_MINOR}.${OTIO_VERSION_PATCH})
 
 set(OTIO_AUTHOR       "Contributors to the OpenTimelineIO project")
@@ -187,7 +193,7 @@ if(WIN32)
     # Windows debug builds for Python require a d in order for the module to
     # load. This also helps ensure that debug builds in general are matched
     # to the Microsoft debug CRT.
-    set(OTIO_DEBUG_POSTFIX "d")
+    set(OTIO_DEBUG_POSTFIX "_d")
 endif()
 
 set_property(GLOBAL PROPERTY USE_FOLDERS ON)

MANIFEST.in

@@ -1,4 +1,4 @@
-include README.md README_contrib.md CHANGELOG.md LICENSE.txt NOTICE.txt CMakeLists.txt
+include README.md README_contrib.md CHANGELOG.md LICENSE.txt NOTICE.txt SECURITY.md CMakeLists.txt
 recursive-include examples *
 recursive-include src *
 recursive-include tests *

README.md

@@ -111,19 +111,17 @@ C++:
 
 #include "opentimelineio/timeline.h"
 
-namespace otio = opentimelineio::OPENTIMELINEIO_VERSION;
-
 void
 main()
 {
-    otio::SerializableObject::Retainer<otio::Timeline> tl(
-            dynamic_cast<otio::Timeline*>(
-                otio::Timeline::from_json_file("taco.otio")
+    OTIO_NS::SerializableObject::Retainer<OTIO_NS::Timeline> tl(
+            dynamic_cast<OTIO_NS::Timeline*>(
+                OTIO_NS::Timeline::from_json_file("taco.otio")
         )
     );
     for (const auto& cl : tl->find_clips())
     {
-        otio::RationalTime dur = cl->duration();
+        OTIO_NS::RationalTime dur = cl->duration();
         std::cout << "Name: " << cl->name() << " [";
         std::cout << dur.value() << "/" << dur.rate() << "]" << std::endl;
     }

SECURITY.md

@@ -0,0 +1,56 @@
+<!-- SPDX-License-Identifier: Apache-2.0 -->
+<!-- Copyright Contributors to the OpenTimelineIO project -->
+
+# Security Policy
+
+## Reporting a Vulnerability
+
+If you think you've found a potential vulnerability in OpenTimelineIO, please
+report it by filing a GitHub [security
+advisory](https://github.com/AcademySoftwareFoundation/OpenTimelineIO/security/advisories/new). Alternatively, email
+[security@opentimeline.io](mailto:security@opentimeline.io?subject=OpenTimelineIO%20Vulnerability%20Report&body=Impact%0A_What%20is%20it,%20who%20is%20impacted_%0A%0APatches%0A_Has%20it%20been%20patched%20and%20in%20which%20version_%0A%0AWorkarounds%0A_Is%20there%20a%20way%20for%20users%20to%20fix%20or%20remediate%20without%20upgrading_%0A%0AReferences%0A_Where%20can%20users%20visit%20to%20find%20out%20more_)
+and provide your contact info for further private/secure discussion.  If your email does not receive a prompt
+acknowledgement, your address may be blocked.
+
+Our policy is to acknowledge the receipt of vulnerability reports
+within 48 hours. Our policy is to address critical security vulnerabilities
+rapidly and post patches within 14 days if possible.
+
+## Known Vulnerabilities
+
+These vulnerabilities are present in the given versions:
+
+* No known vulnerabilities
+
+See the [release notes](https://github.com/AcademySoftwareFoundation/OpenTimelineIO/releases) for more information.
+
+## Supported Versions
+
+This gives guidance about which branches are supported with patches to
+security vulnerabilities.
+
+| Version / branch | Supported                                                                                                                          |
+|------------------|------------------------------------------------------------------------------------------------------------------------------------|
+| main             | :white_check_mark: :construction: ALL fixes immediately, but this is a branch under development and may be unstable in other ways. |
+| 0.18.x           | :white_check_mark: All fixes that can be backported without breaking compatibility.                                            |
+| 0.17.x           | :white_check_mark: All fixes that can be backported without breaking compatibility.                                            |
+| 0.16.x           | :warning: Only the most critical fixes, only if they can be easily backported.                                                     |
+| <= 0.15.x        | :x: No longer receiving patches of any kind.                                                                                       |
+
+  
+### Software Dependencies
+
+#### OpenTimelineIO C++
+
+- [Imath](https://github.com/AcademySoftwareFoundation/Imath) - Provides Vector, Matrix, and Bounding Box primitives. 
+- [rapidjson](https://github.com/Tencent/rapidjson/) - Used in serialization/deserialization of the `.otio` JSON file format.
+
+#### OpenTimelineIO Python
+
+- [pybind11](https://github.com/pybind/pybind11) (only if built with Python bindings) - Used to create Python bindings for the C++ library.
+- [importlib_metadata](https://pypi.org/project/importlib-metadata/) - Provides backward compatability for Python 3.7.
+
+Optionally, OTIOView requires:
+
+- [PySide2](https://pypi.org/project/PySide2/) - on x86_64.
+- [PySide6](https://pypi.org/project/PySide6/) - on AArch64.

docs/tutorials/adapters.md

@@ -19,8 +19,6 @@ To also install a curated list of additional useful adapters, use the [OpenTimel
 - [burnins](https://github.com/OpenTimelineIO/otio-burnins-adapter)
 - [cmx_3600](https://github.com/OpenTimelineIO/otio-cmx3600-adapter)
 - [fcp_xml](https://github.com/OpenTimelineIO/otio-fcp-adapter)
-- [fcpx_xml](https://github.com/OpenTimelineIO/otio-fcpx-xml-adapter)
-- [hls_playlist](https://github.com/OpenTimelineIO/otio-hls-playlist-adapter)
 - [maya_sequencer](https://github.com/OpenTimelineIO/otio-maya-sequencer-adapter)
 - [svg](https://github.com/OpenTimelineIO/otio-svg-adapter)
 - [xges](https://github.com/OpenTimelineIO/otio-xges-adapter)
@@ -32,8 +30,9 @@ These adapters are supported by the broader OpenTimelineIO community. While the
 Below are some other adapters that may be useful to some users:
 
 - [kdenlive](https://invent.kde.org/multimedia/kdenlive-opentimelineio)
+- [fcpx_xml](https://github.com/OpenTimelineIO/otio-fcpx-xml-adapter)
+- [hls_playlist](https://github.com/OpenTimelineIO/otio-hls-playlist-adapter)
 
 ## Custom Adapters
 
 Adapters are implemented as plugins for OpenTimelineIO and can either be registered via an [environment variable](./otio-env-variables) or by packaging in a Python module with a particular entrypoint defined. For more detail, see the [Writing an OTIO Adapter](./write-an-adapter) tutorial.
-

src/opentime/CMakeLists.txt

@@ -7,7 +7,8 @@ set(OPENTIME_HEADER_FILES
     rationalTime.h
     stringPrintf.h
     timeRange.h
-    timeTransform.h)
+    timeTransform.h
+    version.h)
 
 add_library(opentime ${OTIO_SHARED_OR_STATIC_LIB} 
             errorStatus.cpp
@@ -16,12 +17,7 @@ add_library(opentime ${OTIO_SHARED_OR_STATIC_LIB}
 
 add_library(OTIO::opentime ALIAS opentime)
 
-target_include_directories(
-    opentime
-    PRIVATE
-        "${PROJECT_SOURCE_DIR}/src"
-        "${CMAKE_CURRENT_BINARY_DIR}/.."
-)
+target_include_directories(opentime PRIVATE "${PROJECT_SOURCE_DIR}/src")
 
 set_target_properties(opentime PROPERTIES 
     DEBUG_POSTFIX "${OTIO_DEBUG_POSTFIX}"
@@ -56,11 +52,6 @@ target_compile_options(opentime PRIVATE
      $<$<CXX_COMPILER_ID:MSVC>: /EHsc>
 )
 
-configure_file(
-    ${CMAKE_CURRENT_SOURCE_DIR}/version.h.in
-    ${CMAKE_CURRENT_BINARY_DIR}/version.h
-)
-
 if(OTIO_CXX_INSTALL)
     install(FILES ${OPENTIME_HEADER_FILES} 
             DESTINATION "${OTIO_RESOLVED_CXX_INSTALL_DIR}/include/opentime")
@@ -98,12 +89,5 @@ if(OTIO_CXX_INSTALL)
         DESTINATION
             ${OTIO_RESOLVED_CXX_INSTALL_DIR}/share/opentime
     )
-
-    install(
-        FILES
-            ${CMAKE_CURRENT_BINARY_DIR}/version.h
-        DESTINATION
-            "${OTIO_RESOLVED_CXX_INSTALL_DIR}/include/opentime"
-    )
 endif()
 

src/opentime/version.h

@@ -0,0 +1,17 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Contributors to the OpenTimelineIO project
+
+#pragma once
+
+#define OPENTIME_VERSION_MAJOR 0
+#define OPENTIME_VERSION_MINOR 19
+#define OPENTIME_VERSION_PATCH 0
+#define OPENTIME_VERSION v0_19_0
+#define OPENTIME_VERSION_NS v0_19
+
+namespace opentime {
+namespace OPENTIME_VERSION_NS {
+}
+
+using namespace OPENTIME_VERSION_NS;
+} // namespace opentime

src/opentime/version.h.in

@@ -45,7 +45,8 @@ set(OPENTIMELINEIO_HEADER_FILES
     transition.h
     typeRegistry.h
     unknownSchema.h
-    vectorIndexing.h)
+    vectorIndexing.h
+    version.h)
 
 add_library(opentimelineio ${OTIO_SHARED_OR_STATIC_LIB}
     color.cpp
@@ -95,12 +96,7 @@ add_library(opentimelineio ${OTIO_SHARED_OR_STATIC_LIB}
 
 add_library(OTIO::opentimelineio ALIAS opentimelineio)
 
-target_include_directories(
-    opentimelineio
-    PRIVATE
-        "${PROJECT_SOURCE_DIR}/src"
-        "${CMAKE_CURRENT_BINARY_DIR}/.."
-)
+target_include_directories(opentimelineio PRIVATE "${PROJECT_SOURCE_DIR}/src")
 
 if(OTIO_FIND_RAPIDJSON)
     target_include_directories(opentimelineio
@@ -148,11 +144,6 @@ target_compile_options(opentimelineio PRIVATE
      $<$<CXX_COMPILER_ID:MSVC>: /EHsc>
 )
 
-configure_file(
-    ${CMAKE_CURRENT_SOURCE_DIR}/version.h.in
-    ${CMAKE_CURRENT_BINARY_DIR}/version.h
-)
-
 if(OTIO_CXX_INSTALL)
     install(FILES ${OPENTIMELINEIO_HEADER_FILES} 
             DESTINATION "${OTIO_RESOLVED_CXX_INSTALL_DIR}/include/opentimelineio")
@@ -192,11 +183,4 @@ if(OTIO_CXX_INSTALL)
         DESTINATION
             ${OTIO_RESOLVED_CXX_INSTALL_DIR}/share/opentimelineio
     )
-
-    install(
-        FILES
-            ${CMAKE_CURRENT_BINARY_DIR}/version.h
-        DESTINATION
-            "${OTIO_RESOLVED_CXX_INSTALL_DIR}/include/opentimelineio"
-    )
 endif()

src/opentimelineio/CMakeLists.txt

@@ -162,7 +162,7 @@ class OTIO_API_TYPE SerializableObject
         template <typename T>
         bool read(std::string const& key, Retainer<T>* dest)
         {
-            SerializableObject* so;
+            SerializableObject* so = nullptr;
             if (!read(key, &so))
             {
                 return false;