Various fixes

Signed-off-by: Darby Johnston <darbyjohnston@yahoo.com>

Author: darbyjohnston

CMakeLists.txt

@@ -42,7 +42,7 @@ set(OTIO_PYTHON_INSTALL_DIR "" CACHE STRING "Python installation dir (such as th
 # Build options
 #
 # If you are building OpenTimelineIO as a static library you will need to
-# defined OPENTIME_STATIC and OTIO_STATIC. If you use the provided CMake
+# define OPENTIME_STATIC and OTIO_STATIC. If you use the provided CMake
 # config files these will be automatically defined for you. To use the
 # provided config files add `find_package(OpenTimelineIO)` to your
 # CMakeLists.txt file.

examples/bundle.cpp

@@ -1,7 +1,17 @@
 // SPDX-License-Identifier: Apache-2.0
 // Copyright Contributors to the OpenTimelineIO project
 
-// Example OTIO script that can create and extract bundles.
+// Example OTIO program that can create and extract bundles.
+//
+// Usage:
+// * bundle (input.otio) (output.otioz)
+//   Create an .otioz bundle from an .otio file.
+//
+// * bundle (input.otio) (output.otiod)
+//   Create an .otiod bundle from an .otio file.
+//
+// * bundle (input.otioz) (output)
+//   Extract an .otioz bundle.
 
 #include "util.h"
 
@@ -11,9 +21,6 @@
 
 #include <filesystem>
 
-namespace otio = opentimelineio::OPENTIMELINEIO_VERSION;
-namespace bundle = opentimelineio::OPENTIMELINEIO_VERSION::bundle;
-
 bool
 ends_with(std::string const& s, std::string const& find)
 {
@@ -27,6 +34,7 @@ ends_with(std::string const& s, std::string const& find)
 int
 main(int argc, char** argv)
 {
+    // Command line arguments.
     if (argc != 3)
     {
         std::cout << "Usage:\n";
@@ -38,27 +46,29 @@ main(int argc, char** argv)
                   << "Extract an .otioz bundle.\n";
         return 1;
     }
-    const std::string input = otio::to_unix_separators(argv[1]);
-    const std::string output = otio::to_unix_separators(argv[2]);
+    const std::string input = OTIO_NS::to_unix_separators(argv[1]);
+    const std::string output = OTIO_NS::to_unix_separators(argv[2]);
 
     if (ends_with(input, ".otio") && ends_with(output, ".otioz"))
     {
+        // Create an .otioz bundle from an .otio file.
+
         // Open timeline.
-        otio::ErrorStatus                                  error_status;
-        otio::SerializableObject::Retainer<otio::Timeline> timeline(
-            dynamic_cast<otio::Timeline*>(
-                otio::Timeline::from_json_file(input, &error_status)));
-        if (!timeline || otio::is_error(error_status))
+        OTIO_NS::ErrorStatus                                     error_status;
+        OTIO_NS::SerializableObject::Retainer<OTIO_NS::Timeline> timeline(
+            dynamic_cast<OTIO_NS::Timeline*>(
+                OTIO_NS::Timeline::from_json_file(input, &error_status)));
+        if (!timeline || OTIO_NS::is_error(error_status))
         {
             examples::print_error(error_status);
             return 1;
         }
 
         // Create .otioz bundle.
-        bundle::WriteOptions options;
+        OTIO_NS::bundle::WriteOptions options;
         options.parent_path =
             std::filesystem::u8path(input).parent_path().u8string();
-        if (!bundle::to_otioz(
+        if (!OTIO_NS::bundle::to_otioz(
             timeline.value,
             output,
             options,
@@ -71,34 +81,36 @@ main(int argc, char** argv)
     else if (ends_with(input, ".otioz"))
     {
         // Extract .otioz bundle.
-        bundle::OtiozReadOptions options;
+        OTIO_NS::bundle::OtiozReadOptions options;
         options.extract_path = output;
-        otio::ErrorStatus error_status;
-        auto result = bundle::from_otioz(input, options, &error_status);
-        if (otio::is_error(error_status))
+        OTIO_NS::ErrorStatus error_status;
+        auto result = OTIO_NS::bundle::from_otioz(input, options, &error_status);
+        if (OTIO_NS::is_error(error_status))
         {
             examples::print_error(error_status);
             return 1;
         }
     }
     else if (ends_with(input, ".otio") && ends_with(output, ".otiod"))
     {
+        // Create an .otiod bundle from an .otio file.
+
         // Open timeline.
-        otio::ErrorStatus                                  error_status;
-        otio::SerializableObject::Retainer<otio::Timeline> timeline(
-            dynamic_cast<otio::Timeline*>(
-                otio::Timeline::from_json_file(input, &error_status)));
-        if (!timeline || otio::is_error(error_status))
+        OTIO_NS::ErrorStatus                                     error_status;
+        OTIO_NS::SerializableObject::Retainer<OTIO_NS::Timeline> timeline(
+            dynamic_cast<OTIO_NS::Timeline*>(
+                OTIO_NS::Timeline::from_json_file(input, &error_status)));
+        if (!timeline || OTIO_NS::is_error(error_status))
         {
             examples::print_error(error_status);
             return 1;
         }
 
         // Create .otiod bundle.
-        bundle::WriteOptions options;
+        OTIO_NS::bundle::WriteOptions options;
         options.parent_path =
             std::filesystem::u8path(input).parent_path().u8string();
-        if (!bundle::to_otiod(
+        if (!OTIO_NS::bundle::to_otiod(
             timeline.value,
             output,
             options,

examples/util.cpp

@@ -21,7 +21,6 @@
 #undef min
 #endif // min
 #else // _WINDOWS
-#include <sys/stat.h>
 #include <sys/types.h>
 #include <dirent.h>
 #include <fnmatch.h>

src/opentimelineio/bundle.cpp

@@ -5,7 +5,8 @@
 
 #include "opentimelineio/bundleUtils.h"
 
-namespace opentimelineio { namespace OPENTIMELINEIO_VERSION { namespace bundle {
+namespace opentimelineio { namespace OPENTIMELINEIO_VERSION {
+namespace bundle {
 
 size_t
 get_media_size(
@@ -42,4 +43,4 @@ get_media_size(
 }
 
 } // namespace bundle
-}} // namespace opentimelineio::OPENTIMELINEIO_VERSION
+}} // namespace bundle::opentimelineio::OPENTIMELINEIO_VERSION

src/opentimelineio/bundle.h

@@ -6,7 +6,6 @@
 #include "opentimelineio/timeline.h"
 
 namespace opentimelineio { namespace OPENTIMELINEIO_VERSION {
-
 namespace bundle {
 
 /// @brief The current otioz version.
@@ -25,15 +24,15 @@ static std::string const otio_file = "content.otio";
 static std::string const media_dir = "media";
 
 /// @brief This enumeration provides the bundle media reference policy.
-enum class MediaReferencePolicy
+enum class OTIO_API_TYPE 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
+struct OTIO_API_TYPE 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.
@@ -50,7 +49,7 @@ struct WriteOptions
 };
 
 /// @brief Options for reading .otioz bundles.
-struct OtiozReadOptions
+struct OTIO_API_TYPE 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
@@ -59,15 +58,15 @@ struct OtiozReadOptions
 };
 
 /// @brief Options for reading .otiod bundles.
-struct OtiodReadOptions
+struct OTIO_API_TYPE 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(
+OTIO_API size_t get_media_size(
     Timeline const*     timeline,
     WriteOptions const& options      = WriteOptions(),
     ErrorStatus*        error_status = nullptr);
@@ -94,7 +93,7 @@ size_t get_media_size(
 /// @param file_name The bundle file name.
 /// @param options The bundle options.
 /// @param error_status The error status.
-bool to_otioz(
+OTIO_API bool to_otioz(
     Timeline const*     timeline,
     std::string const&  file_name,
     WriteOptions const& options      = WriteOptions(),
@@ -105,7 +104,7 @@ bool to_otioz(
 /// @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(
+OTIO_API Timeline* from_otioz(
     std::string const&      file_name,
     OtiozReadOptions const& options      = OtiozReadOptions(),
     ErrorStatus*            error_status = nullptr);
@@ -122,7 +121,7 @@ Timeline* from_otioz(
 /// @param file_name The bundle file name.
 /// @param options The bundle options.
 /// @param error_status The error status.
-bool to_otiod(
+OTIO_API bool to_otiod(
     Timeline const*     timeline,
     std::string const&  file_name,
     WriteOptions const& options      = WriteOptions(),
@@ -133,10 +132,10 @@ bool to_otiod(
 /// @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(
+OTIO_API Timeline* from_otiod(
     std::string const&      file_name,
     OtiodReadOptions const& options      = OtiodReadOptions(),
     ErrorStatus*            error_status = nullptr);
 
 } // namespace bundle
-}} // namespace opentimelineio::OPENTIMELINEIO_VERSION
+}} // namespace opentimelineio::OPENTIMELINEIO_VERSION::bundle

src/opentimelineio/bundleUtils.cpp

@@ -12,7 +12,8 @@
 
 #include <sstream>
 
-namespace opentimelineio { namespace OPENTIMELINEIO_VERSION { namespace bundle {
+namespace opentimelineio { namespace OPENTIMELINEIO_VERSION {
+namespace bundle {
 
 std::string
 to_string(MediaReferencePolicy media_referenece_policy)

src/opentimelineio/bundleUtils.h

@@ -11,7 +11,7 @@ namespace opentimelineio { namespace OPENTIMELINEIO_VERSION {
 namespace bundle {
 
 /// @brief Convert a media reference policy to a string.
-std::string to_string(MediaReferencePolicy);
+OTIO_API std::string to_string(MediaReferencePolicy);
 
 /// @brief This maps absolute paths of media references to their relative
 /// paths in the bundle media directory.
@@ -26,7 +26,7 @@ typedef std::map<std::filesystem::path, std::filesystem::path> Manifest;
 /// This is considered an internal API.
 /// 
 /// Throws std::exception on errors.
-SerializableObject::Retainer<Timeline> timeline_for_bundle_and_manifest(
+OTIO_API SerializableObject::Retainer<Timeline> timeline_for_bundle_and_manifest(
     SerializableObject::Retainer<Timeline> const&,
     std::filesystem::path const& timeline_dir,
     MediaReferencePolicy media_reference_policy,

src/opentimelineio/errorStatus.cpp

@@ -67,7 +67,7 @@ ErrorStatus::outcome_to_string(Outcome o)
         case NOT_A_GAP:
             return "object is not descendent of Gap type";
         case BUNDLE_SIZE_ERROR:
-            return "error compiting the size of the bundle";
+            return "error computing the size of the bundle";
         case BUNDLE_WRITE_ERROR:
             return "error writing bundle";
         case BUNDLE_READ_ERROR:

src/opentimelineio/fileUtils.cpp

@@ -5,6 +5,12 @@
 
 #include <cstdio>
 #include <filesystem>
+#include <iostream>
+
+#if !defined(_WINDOWS)
+#include <stdlib.h>
+#include <unistd.h>
+#endif // _WINDOWS
 
 namespace opentimelineio { namespace OPENTIMELINEIO_VERSION {
 
@@ -18,11 +24,18 @@ to_unix_separators(std::string const& path)
 
 std::string create_temp_dir()
 {
-    // \todo Replace std::tmpnam(), since it is potentially unsafe. A possible
-    // replacement might be mkdtemp(), but that does not seem to be available
-    // on Cygwin.
+    std::string out;
+#if defined(_WINDOWS)
+    // \todo Replace std::tmpnam() since it is potentially unsafe.
     std::string const out(std::tmpnam(nullptr));
     std::filesystem::create_directory(out);
+#else // _WINDOWS
+    std::string dir = std::filesystem::temp_directory_path() / "XXXXXX";
+    if (mkdtemp(dir.data()))
+    {
+        out = dir;
+    }
+#endif // _WINDOWS
     return out;
 }
 

src/opentimelineio/fileUtils.h

@@ -3,6 +3,7 @@
 
 #pragma once
 
+#include "opentimelineio/export.h"
 #include "opentimelineio/version.h"
 
 namespace opentimelineio { namespace OPENTIMELINEIO_VERSION {
@@ -11,10 +12,12 @@ namespace opentimelineio { namespace OPENTIMELINEIO_VERSION {
 ///@{
 
 /// @brief Convert Windows path separators to UNIX path separators.
-std::string to_unix_separators(std::string const&);
+OTIO_API std::string to_unix_separators(std::string const&);
 
-// Create a temporary directory.
-std::string create_temp_dir();
+/// @brief Create a temporary directory.
+///
+/// This function is only used for the tests and examples.
+OTIO_API std::string create_temp_dir();
 
 ///@}