sample_heritage_json.hpp

Go to the documentation of this file.

#pragma once
 
#include <pulp/audio/sample_heritage.hpp>
 
#include <string>
#include <string_view>
 
namespace pulp::audio {

enum class SampleHeritageJsonStatus : std::uint8_t {
    Ok,
    InvalidJson,
    RootNotObject,
    UnknownField,
    DuplicateField,
    MissingField,
    WrongType,
    InvalidEnum,
    NumberOutOfRange,
    ProfileValidationFailed,
};
 
struct SampleHeritageJsonParseResult {
    SampleHeritageJsonStatus status = SampleHeritageJsonStatus::InvalidJson;
    std::string field_path;
    SampleHeritageProfileStatus profile_status =
        SampleHeritageProfileStatus::UnsupportedSchemaVersion;
    SampleHeritageProfile profile;
 
    bool valid() const noexcept { return status == SampleHeritageJsonStatus::Ok; }
};
 
struct SampleHeritageJsonWriteResult {
    SampleHeritageJsonStatus status =
        SampleHeritageJsonStatus::ProfileValidationFailed;
    SampleHeritageProfileStatus profile_status =
        SampleHeritageProfileStatus::UnsupportedSchemaVersion;
    std::string json;
 
    bool valid() const noexcept { return status == SampleHeritageJsonStatus::Ok; }
};
 
struct SampleHeritageRuntimeStateJsonParseResult {
    SampleHeritageJsonStatus status = SampleHeritageJsonStatus::InvalidJson;
    std::string field_path;
    SampleHeritageRuntimeStateStatus runtime_status =
        SampleHeritageRuntimeStateStatus::InvalidStageLayout;
    SampleHeritageRuntimeState state;
 
    bool valid() const noexcept { return status == SampleHeritageJsonStatus::Ok; }
};
 
struct SampleHeritageRuntimeStateJsonWriteResult {
    SampleHeritageJsonStatus status =
        SampleHeritageJsonStatus::ProfileValidationFailed;
    SampleHeritageRuntimeStateStatus runtime_status =
        SampleHeritageRuntimeStateStatus::InvalidStageLayout;
    std::string json;
 
    bool valid() const noexcept { return status == SampleHeritageJsonStatus::Ok; }
};
 
struct SampleHeritageTypedRuntimeStateJsonParseResult {
    SampleHeritageJsonStatus status = SampleHeritageJsonStatus::InvalidJson;
    std::string field_path;
    SampleHeritageRuntimeStateStatus runtime_status =
        SampleHeritageRuntimeStateStatus::InvalidStageLayout;
    SampleHeritageTypedRuntimeState state;
 
    bool valid() const noexcept { return status == SampleHeritageJsonStatus::Ok; }
};
 
struct SampleHeritageTypedRuntimeStateJsonWriteResult {
    SampleHeritageJsonStatus status =
        SampleHeritageJsonStatus::ProfileValidationFailed;
    SampleHeritageRuntimeStateStatus runtime_status =
        SampleHeritageRuntimeStateStatus::InvalidStageLayout;
    std::string json;
 
    bool valid() const noexcept { return status == SampleHeritageJsonStatus::Ok; }
};

SampleHeritageJsonParseResult parse_sample_heritage_profile_json(
    std::string_view json);

SampleHeritageJsonWriteResult write_sample_heritage_profile_json(
    const SampleHeritageProfile& profile);

SampleHeritageRuntimeStateJsonParseResult parse_sample_heritage_runtime_state_json(
    std::string_view json);
SampleHeritageRuntimeStateJsonWriteResult write_sample_heritage_runtime_state_json(
    const SampleHeritageRuntimeState& state);

SampleHeritageTypedRuntimeStateJsonParseResult
parse_sample_heritage_typed_runtime_state_json(std::string_view json);
SampleHeritageTypedRuntimeStateJsonWriteResult
write_sample_heritage_typed_runtime_state_json(
    const SampleHeritageTypedRuntimeState& state);
 
}  // namespace pulp::audio