Add core C++ support for otioz and otiod, take 2

.gitmodules

@@ -7,3 +7,6 @@
 [submodule "src/deps/Imath"]
 	path = src/deps/Imath
 	url = https://github.com/AcademySoftwareFoundation/Imath
+[submodule "src/deps/minizip-ng"]
+	path = src/deps/minizip-ng
+	url = https://github.com/zlib-ng/minizip-ng.git

CMakeLists.txt

@@ -40,6 +40,7 @@ option(OTIO_INSTALL_COMMANDLINE_TOOLS "Install the OTIO command line tools" ON)
 option(OTIO_FIND_IMATH                "Find Imath using find_package" OFF)
 option(OTIO_FIND_PYBIND11             "Find pybind11 using find_package" OFF)
 option(OTIO_FIND_RAPIDJSON            "Find RapidJSON using find_package" OFF)
+option(OTIO_FIND_MINIZIP_NG           "Find minizip-ng using find_package" OFF)
 set(OTIO_PYTHON_INSTALL_DIR "" CACHE STRING "Python installation dir (such as the site-packages dir)")
 
 # Build options
@@ -270,7 +271,6 @@ else()
 endif()
 
 #----- RapidJSON
-
 if(OTIO_FIND_RAPIDJSON)
     find_package(RapidJSON CONFIG REQUIRED)
     if (RapidJSON_FOUND)
@@ -280,6 +280,16 @@ else()
     message(STATUS "Using src/deps/rapidjson by default")
 endif()
 
+#----- minizip-ng
+if(OTIO_FIND_MINIZIP_NG)
+    find_package(minizip-ng REQUIRED)
+    if (minizip-ng_FOUND)
+        message(STATUS "Found minizip-ng at ${minizip-ng_CONFIG}")
+    endif()
+else()
+    message(STATUS "Using src/deps/minizip-ng by default")
+endif()
+
 # set up the internally hosted dependencies
 add_subdirectory(src/deps)
 

docs/tutorials/otio-plugins.md

@@ -146,6 +146,7 @@ into a single directory named with a suffix of .otiod.
 - write_to_file:
   - input_otio
   - filepath
+  - relative_media_base_dir
   - media_policy
   - dryrun
 
@@ -182,6 +183,7 @@ read on unix and windows platforms.
 - write_to_file:
   - input_otio
   - filepath
+  - relative_media_base_dir
   - media_policy
   - dryrun
 

examples/CMakeLists.txt

@@ -4,14 +4,17 @@ include_directories(${PROJECT_SOURCE_DIR}/src
     ${CMAKE_CURRENT_BINARY_DIR}/../src
     ${PYTHON_INCLUDE_DIRS})
 
-list(APPEND examples conform)
-list(APPEND examples flatten_video_tracks)
-list(APPEND examples summarize_timing)
-list(APPEND examples io_perf_test)
-list(APPEND examples upgrade_downgrade_example)
+set(examples
+    bundle
+    conform
+    flatten_video_tracks
+    summarize_timing
+    io_perf_test
+    upgrade_downgrade_example)
 if(OTIO_PYTHON_INSTALL)
-    list(APPEND examples python_adapters_child_process)
-    list(APPEND examples python_adapters_embed)
+    list(APPEND examples
+        python_adapters_child_process
+        python_adapters_embed)
 endif()
 foreach(example ${examples})
     add_executable(${example} ${example}.cpp util.h util.cpp)

examples/bundle.cpp

@@ -0,0 +1,62 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Contributors to the OpenTimelineIO project
+
+// Example for converting an .otio file into a bundle.
+
+#include "util.h"
+
+#include <opentimelineio/bundle.h>
+
+#include <filesystem>
+
+using namespace OTIO_NS;
+
+int
+main(int argc, char** argv)
+{
+    if (argc != 3) {
+        std::cout << "Usage: bundle (input.otio) (output.otioz|output.otiod)" << std::endl;
+        return 1;
+    }
+    const std::string input  = examples::normalize_path(argv[1]);
+    const std::string output = examples::normalize_path(argv[2]);
+
+    // Read the timeline
+    ErrorStatus                            error_status;
+    SerializableObject::Retainer<Timeline> timeline(dynamic_cast<Timeline*>(
+        Timeline::from_json_file(input, &error_status)));
+    if (!timeline || is_error(error_status)) {
+        examples::print_error(error_status);
+        return 1;
+    }
+
+    // Write the bundle
+    bundle::WriteOptions options;
+    options.relative_media_base_dir =
+        std::filesystem::u8path(input).parent_path().u8string();
+    auto const ext = std::filesystem::u8path(output).extension().u8string();
+    if (".otiod" == ext)
+    {
+        if (!bundle::write_otiod(
+            timeline,
+            output,
+            options,
+            &error_status)) {
+            examples::print_error(error_status);
+            return 1;
+        }
+    }
+    else
+    {
+        if (!bundle::write_otioz(
+            timeline,
+            output,
+            options,
+            &error_status)) {
+            examples::print_error(error_status);
+            return 1;
+        }
+    }
+
+    return 0;
+}

src/deps/CMakeLists.txt

@@ -17,6 +17,10 @@ if(NOT OTIO_FIND_RAPIDJSON)
     set(DEPS_SUBMODULES ${DEPS_SUBMODULES} rapidjson)
 endif()
 
+if(NOT OTIO_FIND_MINIZIP_NG)
+    set(DEPS_SUBMODULES ${DEPS_SUBMODULES} minizip-ng)
+endif()
+
 foreach(submodule IN LISTS DEPS_SUBMODULES)
     file(GLOB SUBMOD_CONTENTS "${submodule}/*")
     list(LENGTH SUBMOD_CONTENTS SUBMOD_CONTENT_LEN)
@@ -60,3 +64,19 @@ if(NOT OTIO_FIND_IMATH)
     endif()
 endif()
 
+if(NOT OTIO_FIND_MINIZIP_NG)
+    set(CMAKE_POSITION_INDEPENDENT_CODE ON)
+    set(MZ_BZIP2 OFF)
+    set(MZ_LZMA OFF)
+    set(MZ_PPMD OFF)
+    set(MZ_ZSTD OFF)
+    set(MZ_LIBCOMP OFF)
+    set(MZ_PKCRYPT OFF)
+    set(MZ_WZAES OFF)
+    set(MZ_OPENSSL OFF)
+    set(MZ_LIBBSD OFF)
+    set(MZ_ICONV OFF)
+    set(MZ_FETCH_LIBS ON)
+    set(SKIP_INSTALL_ALL ON)
+    add_subdirectory(minizip-ng)
+endif()

src/opentimelineio/CMakeLists.txt

@@ -4,6 +4,7 @@
 set(OPENTIMELINEIO_HEADER_FILES
     anyDictionary.h
     anyVector.h
+    bundle.h
     color.h
     clip.h
     composable.h
@@ -41,6 +42,7 @@ set(OPENTIMELINEIO_HEADER_FILES
     version.h)
 
 add_library(opentimelineio ${OTIO_SHARED_OR_STATIC_LIB}
+    bundle.cpp
     color.cpp
     clip.cpp
     composable.cpp
@@ -90,9 +92,9 @@ else()
         PRIVATE "${PROJECT_SOURCE_DIR}/src/deps/rapidjson/include")
 endif()
 
-
-target_link_libraries(opentimelineio 
-    PUBLIC opentime Imath::Imath)
+target_link_libraries(opentimelineio
+    PUBLIC opentime Imath::Imath
+    PRIVATE MINIZIP::minizip)
 
 set_target_properties(opentimelineio PROPERTIES
     DEBUG_POSTFIX "${OTIO_DEBUG_POSTFIX}"
@@ -134,6 +136,19 @@ if(OTIO_CXX_INSTALL)
 
     set(OPENTIMELINEIO_INCLUDES ${OTIO_RESOLVED_CXX_INSTALL_DIR}/include)
 
+    if(NOT OTIO_FIND_MINIZIP_NG)
+        install(TARGETS minizip
+            EXPORT OpenTimelineIOTargets
+            ARCHIVE DESTINATION "${OTIO_RESOLVED_CXX_DYLIB_INSTALL_DIR}"
+            LIBRARY DESTINATION "${OTIO_RESOLVED_CXX_DYLIB_INSTALL_DIR}"
+            RUNTIME DESTINATION "${OTIO_RESOLVED_CXX_DYLIB_INSTALL_DIR}")
+    endif()
+
+    set(OTIO_CONFIG_DEPENDENCIES "")
+    if(OTIO_FIND_MINIZIP_NG)
+        string(APPEND OTIO_CONFIG_DEPENDENCIES "find_dependency(minizip-ng)\n")
+    endif()
+
     install(TARGETS opentimelineio
            EXPORT OpenTimelineIOTargets
            INCLUDES DESTINATION "${OPENTIMELINEIO_INCLUDES}"

src/opentimelineio/OpenTimelineIOConfig.cmake.in

@@ -3,5 +3,6 @@
 include(CMakeFindDependencyMacro)
 find_dependency(OpenTime)
 find_dependency(Imath)
+@OTIO_CONFIG_DEPENDENCIES@
 
 include("${CMAKE_CURRENT_LIST_DIR}/OpenTimelineIOTargets.cmake")