dawproject_import.hpp

Go to the documentation of this file.

#pragma once
 
#include <pulp/runtime/result.hpp>
#include <pulp/timeline/model.hpp>
 
#include <cstddef>
#include <cstdint>
#include <functional>
#include <optional>
#include <span>
#include <string>
#include <string_view>
#include <vector>
 
namespace pulp::timeline {



enum class DawProjectImportErrorCode : std::uint8_t {
    ParseError,             
    MissingRoot,            
    UnsupportedVersion,     
    UnsupportedFeature,     
    MissingAttribute,       
    InvalidValue,           
    MissingMediaBytes,      
    DuplicateTrackId,       
    DanglingTrackReference, 
    ModelRejected,          
    LimitExceeded,          
};

struct DawProjectImportError {
    DawProjectImportErrorCode code = DawProjectImportErrorCode::ParseError;
    std::string message;
    ModelError model_error{};
};

using DawProjectMediaResolver =
    std::function<std::optional<std::vector<std::uint8_t>>(std::string_view package_path)>;
 
namespace detail {
struct DawProjectMediaViewResolver {
    // The returned view is consumed synchronously and is never retained.
    using Function = std::optional<std::span<const std::uint8_t>> (*)(void*, std::string_view);
    void* context = nullptr;
    Function function = nullptr;
    explicit operator bool() const noexcept { return function != nullptr; }
    std::optional<std::span<const std::uint8_t>> operator()(std::string_view path) const {
        return function(context, path);
    }
};
}

struct DawProjectImportLimits {
    std::size_t max_xml_bytes = 64u * 1024u * 1024u;
    std::size_t max_tracks = 16'384;
    std::size_t max_clips = 1'000'000;
    std::size_t max_notes = 5'000'000;
    std::size_t max_media_assets = 16'384;
    std::size_t max_media_resolver_calls = 1'000'000;
    std::size_t max_package_path_bytes = 4'096;
    std::uint64_t max_media_bytes_per_resolver_call = 2ull * 1024ull * 1024ull * 1024ull;
    std::uint64_t max_total_media_bytes = 16ull * 1024ull * 1024ull * 1024ull;
};

runtime::Result<Project, DawProjectImportError> import_dawproject_xml(std::string_view project_xml);

runtime::Result<Project, DawProjectImportError>
import_dawproject_xml(std::string_view project_xml, DawProjectMediaResolver media_resolver);

runtime::Result<Project, DawProjectImportError>
import_dawproject_xml(std::string_view project_xml, DawProjectMediaResolver media_resolver,
                      const DawProjectImportLimits& limits);
 
namespace detail {
runtime::Result<Project, DawProjectImportError>
import_dawproject_xml_view(std::string_view project_xml,
                           DawProjectMediaViewResolver media_resolver,
                           const DawProjectImportLimits& limits);
}

 
} // namespace pulp::timeline