Merge branch 'main' into MB_NewOTIOIntegration

* main:
  Add Python 3.10 to CI (AcademySoftwareFoundation#1256)
  Fix missing init metadata (AcademySoftwareFoundation#1251)
  Support OTIO_PLUGIN_MANIFEST_PATH being set to an emptry string (AcademySoftwareFoundation#1253)
  Add ALE adapter argument `ale_name_column_key` (AcademySoftwareFoundation#1248)
  AAF Adapter: Mob transcription heuristics (AcademySoftwareFoundation#1249)
  Bump src/deps/Imath from `bd6f74c` to `bd254da` (AcademySoftwareFoundation#1245)
  clang notices that constexpr can't be used on a mutating function (AcademySoftwareFoundation#1242)

Author: andrewmoore-nz

.github/workflows/python-package.yml

@@ -83,7 +83,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        python-version: ['2.7', '3.7', '3.8', '3.9']
+        python-version: ['2.7', '3.7', '3.8', '3.9', '3.10']
 
     env:
       OTIO_CXX_COVERAGE_BUILD: ON
@@ -133,7 +133,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        python-build: [cp27*, cp37*, cp38*, cp39*]
+        python-build: ['cp27*', 'cp37*', 'cp38*', 'cp39*', 'cp310*']
     steps:
       - uses: actions/checkout@v3
 
@@ -153,13 +153,26 @@ jobs:
           echo "DISTUTILS_USE_SDK=1" >> $GITHUB_ENV
           echo "MSSdk=1" >> $GITHUB_ENV
 
-      - name: Build wheels
+      - name: Build wheels (Python 2.7)
+        if: matrix.python-build == 'cp27*'
+        # cibuildwheel 1.12.0 is the last release that supported Python 2.7.
         uses: pypa/[email protected]
         with:
           output-dir: wheelhouse
         env:
           CIBW_BUILD: ${{ matrix.python-build }}
 
+      - name: Build wheels (Python 3)
+        uses: pypa/[email protected]
+        if: matrix.python-build != 'cp27*'
+        with:
+          output-dir: wheelhouse
+        env:
+          CIBW_BUILD: ${{ matrix.python-build }}
+          CIBW_SKIP: '*musllinux*'
+          CIBW_MANYLINUX_X86_64_IMAGE: manylinux2010
+          CIBW_MANYLINUX_I686_IMAGE: manylinux2010
+
       - uses: actions/upload-artifact@v2
         with:
           name: wheels

CMakeLists.txt

@@ -28,6 +28,7 @@ project(OpenTimelineIO VERSION ${OTIO_VERSION} LANGUAGES C CXX)
 option(OTIO_CXX_INSTALL               "Install the C++ bindings" ON)
 option(OTIO_PYTHON_INSTALL            "Install the Python bindings" OFF)
 option(OTIO_DEPENDENCIES_INSTALL      "Install OTIO's C++ header dependencies (any and nonstd)" ON)
+option(OTIO_INSTALL_PYTHON_MODULES    "Install OTIO pure Python modules/files" ON)
 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_PYTHON_INSTALL_DIR "" CACHE STRING "Python installation dir (such as the site-packages dir)")
@@ -75,7 +76,7 @@ if(OTIO_PYTHON_INSTALL)
         message(STATUS "OTIO Defaulting Python install to ${OTIO_RESOLVED_PYTHON_INSTALL_DIR}")
     else()
         # either python_install or install_prefix have been set
-        if(OTIO_PYTHON_INSTALL_DIR_INITIALIZED_TO_DEFAULT)
+        if(NOT OTIO_PYTHON_INSTALL_DIR)
             # CMAKE_INSTALL_PREFIX was set, so install the python components there
             set(OTIO_RESOLVED_PYTHON_INSTALL_DIR "${CMAKE_INSTALL_PREFIX}/python")
 

README.md

@@ -4,7 +4,7 @@ OpenTimelineIO
 ==============
 
 [![Supported VFX Platform Versions](https://img.shields.io/badge/vfx%20platform-2018--2021-lightgrey.svg)](http://www.vfxplatform.com/)
-![Supported Versions](https://img.shields.io/badge/python-2.7%2C%203.7%2C%203.8%2C%203.9-blue)
+![Supported Versions](https://img.shields.io/badge/python-2.7%2C%203.7%2C%203.8%2C%203.9%2C%203.10-blue)
 [![Build Status](https://github.com/PixarAnimationStudios/OpenTimelineIO/actions/workflows/python-package.yml/badge.svg)](https://github.com/PixarAnimationStudios/OpenTimelineIO/actions/workflows/python-package.yml)
 [![codecov](https://codecov.io/gh/PixarAnimationStudios/OpenTimelineIO/branch/main/graph/badge.svg)](https://codecov.io/gh/PixarAnimationStudios/OpenTimelineIO)
 [![docs](https://readthedocs.org/projects/opentimelineio/badge/?version=latest)](https://opentimelineio.readthedocs.io/en/latest/index.html)
@@ -52,8 +52,7 @@ Supported VFX Platforms
 -----------------
 The current release supports:
 - VFX platform 2021, 2020, 2019, 2018
-- Python 2.7 - 3.9
-- Notice that Python 2.7 is deprecated & we plan to drop it in OTIO release 0.15
+- Python 2.7 - 3.10
 
 For more information on our vfxplatform support policy: [Contribution Guidelines Documentation Page](https://opentimelineio.readthedocs.io/en/latest/tutorials/contributing.html)
 For more information on the vfxplatform: [VFX Platform Homepage](https://vfxplatform.com)

contrib/opentimelineio_contrib/adapters/advanced_authoring_format.py

@@ -1627,6 +1627,50 @@ def _contains_something_valuable(thing):
     return True
 
 
+def _get_mobs_for_transcription(storage):
+    """
+    When we describe our AAF into OTIO space, we apply the following heuristic:
+
+    1) First look for top level mobs and if found use that to transcribe.
+
+    2) If we don't have top level mobs, look for composition mobs and use them to
+    transcribe.
+
+    3) Lastly if we don't have either, try to use master mobs to transcribe.
+
+    If we don't find any Mobs, just tell the user and do transcrption on an empty
+    list (to generate some 'empty-level' OTIO structure)
+
+    This heuristic is based on 'real-world' examples. There may still be some
+    corner cases / open questions (like could there be metadata on both
+    a composition mob and master mob? And if so, who would 'win'?)
+
+    In any way, this heuristic satisfies the current set of AAFs we are using
+    in our test-environment.
+
+    """
+
+    top_level_mobs = list(storage.toplevel())
+
+    if len(top_level_mobs) > 0:
+        _transcribe_log("---\nTranscribing top level mobs\n---")
+        return top_level_mobs
+
+    composition_mobs = list(storage.compositionmobs())
+    if len(composition_mobs) > 0:
+        _transcribe_log("---\nTranscribing composition mobs\n---")
+        return composition_mobs
+
+    master_mobs = list(storage.mastermobs())
+    if len(master_mobs) > 0:
+        _transcribe_log("---\nTranscribing master mobs\n---")
+        return master_mobs
+
+    _transcribe_log("---\nNo mobs found to transcribe\n---")
+
+    return []
+
+
 def read_from_file(
     filepath,
     simplify=True,
@@ -1657,25 +1701,20 @@ def read_from_file(
     _BAKE_KEYFRAMED_PROPERTIES_VALUES = bake_keyframed_properties
 
     with aaf2.open(filepath) as aaf_file:
-
-        storage = aaf_file.content
-
-        # Note: We're skipping: f.header
+        # Note: We're skipping: aaf_file.header
         # Is there something valuable in there?
-        _transcribe_log("---\nTranscribing top level mobs\n---", 0)
 
-        # Get just the top-level MOBS from the AAF
-        top = list(storage.toplevel())
+        storage = aaf_file.content
+        mobs_to_transcribe = _get_mobs_for_transcription(storage)
 
-        # Transcribe just the top-level mobs
-        result = _transcribe(top, parents=list(), edit_rate=None)
+        result = _transcribe(mobs_to_transcribe, parents=list(), edit_rate=None)
 
     # Attach marker to the appropriate clip, gap etc.
     if attach_markers:
         result = _attach_markers(result)
 
     # AAF is typically more deeply nested than OTIO.
-    # Lets try to simplify the structure by collapsing or removing
+    # Let's try to simplify the structure by collapsing or removing
     # unnecessary stuff.
     if simplify:
         result = _simplify(result)

contrib/opentimelineio_contrib/adapters/ale.py

@@ -53,7 +53,7 @@ class ALEParseError(otio.exceptions.OTIOError):
     pass
 
 
-def _parse_data_line(line, columns, fps):
+def _parse_data_line(line, columns, fps, ale_name_column_key='Name'):
     row = line.split("\t")
 
     if len(row) < len(columns):
@@ -71,7 +71,7 @@ def _parse_data_line(line, columns, fps):
         metadata = dict(zip(columns, row))
 
         clip = otio.schema.Clip()
-        clip.name = metadata.pop("Name", None)
+        clip.name = metadata.get(ale_name_column_key, '')
 
         # When looking for Start, Duration and End, they might be missing
         # or blank. Treat None and "" as the same via: get(k,"")!=""
@@ -204,7 +204,8 @@ def _video_format_from_metadata(clips):
         return AVID_VIDEO_FORMAT_FROM_WIDTH_HEIGHT(max_width, max_height)
 
 
-def read_from_string(input_str, fps=24):
+def read_from_string(input_str, fps=24, **adapter_argument_map):
+    ale_name_column_key = adapter_argument_map.get('ale_name_column_key', 'Name')
 
     collection = otio.schema.SerializableCollection()
     header = {}
@@ -255,7 +256,10 @@ def nextline(lines):
                 if line.strip() == "":
                     continue
 
-                clip = _parse_data_line(line, columns, fps)
+                clip = _parse_data_line(line,
+                                        columns,
+                                        fps,
+                                        ale_name_column_key=ale_name_column_key)
 
                 collection.append(clip)
 

setup.py

@@ -91,6 +91,10 @@ def generate_cmake_arguments(self):
             '-DOTIO_SHARED_LIBS:BOOL=OFF',
             '-DCMAKE_BUILD_TYPE=' + self.build_config,
             '-DOTIO_PYTHON_INSTALL_DIR=' + install_dir,
+            # turn off the C++ tests during a Python build
+            '-DBUILD_TESTING:BOOL=OFF',
+            # Python modules wil be installed by setuptools.
+            '-DOTIO_INSTALL_PYTHON_MODULES:BOOL=OFF',
         ]
 
         if platform.system() == "Windows":
@@ -290,6 +294,7 @@ def test_otio():
         'Programming Language :: Python :: 3.7',
         'Programming Language :: Python :: 3.8',
         'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10',
         'Operating System :: OS Independent',
         'Natural Language :: English',
     ],

src/opentime/rationalTime.h

@@ -153,7 +153,7 @@ class RationalTime
 
     std::string to_time_string() const;
 
-    constexpr RationalTime const& operator+=(RationalTime other) noexcept
+   RationalTime const& operator+=(RationalTime other) noexcept
     {
         if (_rate < other._rate)
         {
@@ -167,7 +167,7 @@ class RationalTime
         return *this;
     }
 
-    constexpr RationalTime const& operator-=(RationalTime other) noexcept
+   RationalTime const& operator-=(RationalTime other) noexcept
     {
         if (_rate < other._rate)
         {

src/py-opentimelineio/CMakeLists.txt

@@ -4,18 +4,20 @@
 add_subdirectory(opentime-bindings)
 add_subdirectory(opentimelineio-bindings)
 
-# Install pure-python OTIO packages to match PyPI wheel structure
-install(DIRECTORY "${PROJECT_SOURCE_DIR}/src/py-opentimelineio/opentimelineio/"
-    DESTINATION "${OTIO_RESOLVED_PYTHON_INSTALL_DIR}/opentimelineio")
+if(OTIO_INSTALL_PYTHON_MODULES)
+    # Install pure-python OTIO packages to match PyPI wheel structure
+    install(DIRECTORY "${PROJECT_SOURCE_DIR}/src/py-opentimelineio/opentimelineio/"
+        DESTINATION "${OTIO_RESOLVED_PYTHON_INSTALL_DIR}/opentimelineio")
 
-if(OTIO_INSTALL_COMMANDLINE_TOOLS)
-    install(DIRECTORY "${PROJECT_SOURCE_DIR}/src/opentimelineview"
-        DESTINATION "${OTIO_RESOLVED_PYTHON_INSTALL_DIR}")
-endif()
+    if(OTIO_INSTALL_COMMANDLINE_TOOLS)
+        install(DIRECTORY "${PROJECT_SOURCE_DIR}/src/opentimelineview"
+            DESTINATION "${OTIO_RESOLVED_PYTHON_INSTALL_DIR}")
+    endif()
 
-if(OTIO_INSTALL_CONTRIB)
-    install(DIRECTORY "${PROJECT_SOURCE_DIR}/contrib/opentimelineio_contrib"
-        DESTINATION "${OTIO_RESOLVED_PYTHON_INSTALL_DIR}"
-        PATTERN "tests" EXCLUDE
-        PATTERN "Makefile" EXCLUDE)
+    if(OTIO_INSTALL_CONTRIB)
+        install(DIRECTORY "${PROJECT_SOURCE_DIR}/contrib/opentimelineio_contrib"
+            DESTINATION "${OTIO_RESOLVED_PYTHON_INSTALL_DIR}"
+            PATTERN "tests" EXCLUDE
+            PATTERN "Makefile" EXCLUDE)
+    endif()
 endif()

src/py-opentimelineio/opentimelineio/plugins/manifest.py

@@ -232,9 +232,10 @@ def load_manifest():
 
     # Read plugin manifests defined on the $OTIO_PLUGIN_MANIFEST_PATH
     # environment variable.  This variable is an os.pathsep separated list of
-    # file paths to manifest json files.
+    # file paths to manifest json files. Can be set to "" to indicate no
+    # local custom manifest path.
     _local_manifest_path = os.environ.get("OTIO_PLUGIN_MANIFEST_PATH", None)
-    if _local_manifest_path is not None:
+    if _local_manifest_path:
         for src_json_path in _local_manifest_path.split(os.pathsep):
             json_path = os.path.abspath(src_json_path)
             if (