Restore changes

Signed-off-by: Darby Johnston <[email protected]>

Author: darbyjohnston

src/deps/CMakeLists.txt

@@ -30,6 +30,7 @@ endif()
 
 if(NOT OTIO_FIND_IMATH)
     set(BUILD_SHARED_LIBS OFF)
+    add_subdirectory(Imath)
 endif()
 
 if(NOT OTIO_FIND_MINIZIP_NG)

src/opentimelineio/CMakeLists.txt

@@ -4,6 +4,8 @@
 set(OPENTIMELINEIO_HEADER_FILES
     anyDictionary.h
     anyVector.h
+    bundle.h
+    bundleUtils.h
     color.h
     clip.h
     composable.h
@@ -13,6 +15,7 @@ set(OPENTIMELINEIO_HEADER_FILES
     effect.h
     errorStatus.h
     externalReference.h
+    fileUtils.h
     freezeFrame.h
     gap.h
     generatorReference.h
@@ -36,10 +39,13 @@ set(OPENTIMELINEIO_HEADER_FILES
     transition.h
     typeRegistry.h
     unknownSchema.h
+    urlUtils.h
     vectorIndexing.h
     version.h)
 
 add_library(opentimelineio ${OTIO_SHARED_OR_STATIC_LIB}
+    bundle.cpp
+    bundleUtils.cpp
     color.cpp
     clip.cpp
     composable.cpp
@@ -49,6 +55,7 @@ add_library(opentimelineio ${OTIO_SHARED_OR_STATIC_LIB}
     effect.cpp
     errorStatus.cpp
     externalReference.cpp
+    fileUtils.cpp
     freezeFrame.cpp
     gap.cpp
     generatorReference.cpp
@@ -58,6 +65,8 @@ add_library(opentimelineio ${OTIO_SHARED_OR_STATIC_LIB}
     marker.cpp
     mediaReference.cpp
     missingReference.cpp
+    otiod.cpp
+    otioz.cpp
     safely_typed_any.cpp
     serializableCollection.cpp
     serializableObject.cpp
@@ -74,6 +83,7 @@ add_library(opentimelineio ${OTIO_SHARED_OR_STATIC_LIB}
     transition.cpp
     typeRegistry.cpp
     unknownSchema.cpp 
+    urlUtils.cpp
     CORE_VERSION_MAP.cpp
     ${OPENTIMELINEIO_HEADER_FILES})
 

src/opentimelineio/OpenTimelineIOConfig.cmake.in

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

src/opentimelineio/bundle.cpp

@@ -0,0 +1,45 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Contributors to the OpenTimelineIO project
+
+#include "opentimelineio/bundle.h"
+
+#include "opentimelineio/bundleUtils.h"
+
+namespace opentimelineio { namespace OPENTIMELINEIO_VERSION { namespace bundle {
+
+size_t
+get_media_size(
+    Timeline const*     timeline,
+    WriteOptions const& options,
+    ErrorStatus*        error_status)
+{
+    size_t byte_count = 0;
+    try
+    {
+        // Get the file manifest.
+        std::map<std::filesystem::path, std::filesystem::path> manifest;
+        timeline_for_bundle_and_manifest(
+            timeline,
+            std::filesystem::u8path(options.parent_path),
+            options.media_policy,
+            manifest);
+
+        // Count the bytes in each file.
+        for (auto const& file: manifest)
+        {
+            byte_count += std::filesystem::file_size(file.first);
+        }
+    }
+    catch (std::exception const& e)
+    {
+        if (error_status)
+        {
+            *error_status =
+                ErrorStatus(ErrorStatus::BUNDLE_SIZE_ERROR, e.what());
+        }
+    }
+    return byte_count;
+}
+
+} // namespace bundle
+}} // namespace opentimelineio::OPENTIMELINEIO_VERSION

src/opentimelineio/bundle.h

@@ -0,0 +1,142 @@
+// SPDX-License-Identifier: Apache-2.0
+// Copyright Contributors to the OpenTimelineIO project
+
+#pragma once
+
+#include "opentimelineio/timeline.h"
+
+namespace opentimelineio { namespace OPENTIMELINEIO_VERSION {
+
+namespace bundle {
+
+/// @brief The current otioz version.
+static std::string const otioz_version = "1.0.0";
+
+/// @brief The current otiod version.
+static std::string const otiod_version = "1.0.0";
+
+/// @brief The version file name in the bundle.
+static std::string const version_file = "version.txt";
+
+/// @brief The OTIO file name in the bundle.
+static std::string const otio_file = "content.otio";
+
+/// @brief The media directory name in the bundle.
+static std::string const media_dir = "media";
+
+/// @brief This enumeration provides the bundle media reference policy.
+enum class MediaReferencePolicy
+{
+    ErrorIfNotFile,   ///< Return an error if there are any non-file media references.
+    MissingIfNotFile, ///< Replace non-file media references with missing references.
+    AllMissing        ///< Replace all media references with missing references.
+};
+
+/// @brief Options for writing bundles.
+struct WriteOptions
+{
+    /// @brief The parent path is used to locate media with relative paths. If
+    /// parent path is empty, paths are relative to the current working directory.
+    std::string parent_path;
+
+    /// @brief The bundle media reference policy.
+    MediaReferencePolicy media_policy = MediaReferencePolicy::ErrorIfNotFile;
+
+    /// @todo Add comment.
+    schema_version_map const* target_family_label_spec = nullptr;
+
+    /// @brief The number of spaces to use for JSON indentation.
+    int indent = 4;
+};
+
+/// @brief Options for reading .otioz bundles.
+struct OtiozReadOptions
+{
+    /// @brief Extract the contents of the bundle to the given path. If the
+    /// path is empty, the contents are not extracted, and only the timeline
+    /// is read from the bundle.
+    std::string extract_path;
+};
+
+/// @brief Options for reading .otiod bundles.
+struct OtiodReadOptions
+{
+    /// @brief Use absolute paths for media references.
+    bool absolute_media_reference_paths = false;
+};
+
+/// @brief Get the total size (in bytes) of the media files that will be
+/// put into the bundle.
+size_t get_media_size(
+    Timeline const*     timeline,
+    WriteOptions const& options      = WriteOptions(),
+    ErrorStatus*        error_status = nullptr);
+
+/// @brief Write a timeline and it's referenced media to an .otioz bundle.
+///
+/// Takes as input a timeline that has media references which are all
+/// ExternalReferences, with target_urls to files with unique basenames that are
+/// accessible through the file system. The timeline .otio file, a version file,
+/// and media references are bundled into a single zip file with the suffix
+/// .otioz.
+///
+/// The timline .otio file and version file are compressed using the ZIP
+/// "deflate" mode. All media files are store uncompressed.
+///
+/// Can error out if files are not locally referenced. or provide missing
+/// references.
+///
+/// Note that .otioz files _always_ use the unix style path separator ('/').
+/// This ensures that regardless of which platform a bundle was created on, it
+/// can be read on UNIX and Windows platforms.
+///
+/// @param timeline The timeline to write.
+/// @param file_name The bundle file name.
+/// @param options The bundle options.
+/// @param error_status The error status.
+bool to_otioz(
+    Timeline const*     timeline,
+    std::string const&  file_name,
+    WriteOptions const& options      = WriteOptions(),
+    ErrorStatus*        error_status = nullptr);
+
+/// @brief Read a timeline from an .otioz bundle.
+///
+/// @param file_name The bundle file name.
+/// @param output_dir The directory where the bundle will be extracted.
+/// @param error_status The error status.
+Timeline* from_otioz(
+    std::string const&      file_name,
+    OtiozReadOptions const& options      = OtiozReadOptions(),
+    ErrorStatus*            error_status = nullptr);
+
+/// @brief Write a timeline and it's referenced media to an .otiod bundle.
+///
+/// Takes as input a timeline that has media references which are all
+/// ExternalReferences, with target_urls to files with unique basenames that are
+/// accessible through the file system. The timeline .otio file, a version file,
+/// and media references are bundled into a single directory named with a
+/// suffix of .otiod.
+///
+/// @param timeline The timeline to write.
+/// @param file_name The bundle file name.
+/// @param options The bundle options.
+/// @param error_status The error status.
+bool to_otiod(
+    Timeline const*     timeline,
+    std::string const&  file_name,
+    WriteOptions const& options      = WriteOptions(),
+    ErrorStatus*        error_status = nullptr);
+
+/// @brief Read a timeline from an .otiod bundle.
+///
+/// @param file_name The bundle file name.
+/// @param timeline_file_name Returns the timeline file name.
+/// @param error_status The error status.
+Timeline* from_otiod(
+    std::string const&      file_name,
+    OtiodReadOptions const& options      = OtiodReadOptions(),
+    ErrorStatus*            error_status = nullptr);
+
+} // namespace bundle
+}} // namespace opentimelineio::OPENTIMELINEIO_VERSION