sample_heritage_runtime_state.hpp

Go to the documentation of this file.

#pragma once
 
#include <pulp/audio/sample_heritage_schema.hpp>
 
#include <algorithm>
#include <array>
#include <cstdint>
#include <iterator>
#include <string_view>
#include <type_traits>
 
namespace pulp::audio {
 
inline constexpr std::uint32_t kSampleHeritageRuntimeStateSchemaVersion = 1;
inline constexpr std::uint32_t kSampleHeritageTypedRuntimeStateSchemaVersion = 2;
inline constexpr std::size_t kSampleHeritageRuntimeVoiceSlots = 8;
 
enum class SampleHeritageRuntimeRngStageType : std::uint8_t {
    Quantization,
    Noise,
    LiveCyclic,
};
 
struct SampleHeritageRuntimeRngState {
    std::uint8_t stage_index = 0;
    SampleHeritageRuntimeRngStageType stage_type =
        SampleHeritageRuntimeRngStageType::Quantization;
    std::uint64_t random_state = 0;
};

struct SampleHeritageRuntimeState {
    std::uint32_t schema_version = kSampleHeritageRuntimeStateSchemaVersion;
    std::uint32_t profile_schema_version = 0;
    std::array<char, kSampleHeritageMaximumProfileIdBytes + 1> profile_id{};
    std::uint32_t profile_digest_version = kSampleHeritageProfileDigestVersion;
    std::array<std::uint8_t, 32> profile_digest{};
    std::array<SampleHeritageRuntimeRngState, kSampleHeritageMaximumStages>
        rng_states{};
    std::size_t rng_state_count = 0;
 
    std::string_view bound_profile_id() const noexcept {
        const auto end = std::find(profile_id.begin(), profile_id.end(), '\0');
        return {profile_id.data(),
                static_cast<std::size_t>(std::distance(profile_id.begin(), end))};
    }
};
 
struct SampleHeritageRuntimeEngineState {
    std::array<SampleHeritageRuntimeRngState, kSampleHeritageMaximumStages>
        rng_states{};
    std::size_t rng_state_count = 0;
};
 
struct SampleHeritageVoiceRuntimeState {
    std::uint8_t slot_index = 0;
    SampleHeritageRuntimeEngineState engine{};
};

struct SampleHeritageTypedRuntimeState {
    std::uint32_t schema_version =
        kSampleHeritageTypedRuntimeStateSchemaVersion;
    std::uint32_t profile_schema_version = 0;
    std::array<char, kSampleHeritageMaximumProfileIdBytes + 1> profile_id{};
    std::uint32_t profile_digest_version = kSampleHeritageProfileDigestVersion;
    std::array<std::uint8_t, 32> profile_digest{};
    double host_sample_rate = 0.0;
    std::array<SampleHeritageVoiceRuntimeState,
               kSampleHeritageRuntimeVoiceSlots> voice_states{};
    SampleHeritageRuntimeEngineState bus_state{};
 
    constexpr SampleHeritageTypedRuntimeState() noexcept {
        for (std::size_t index = 0; index < voice_states.size(); ++index)
            voice_states[index].slot_index = static_cast<std::uint8_t>(index);
    }
 
    std::string_view bound_profile_id() const noexcept {
        const auto end = std::find(profile_id.begin(), profile_id.end(), '\0');
        return {profile_id.data(),
                static_cast<std::size_t>(std::distance(profile_id.begin(), end))};
    }
};
 
static_assert(std::is_trivially_copyable_v<SampleHeritageTypedRuntimeState>);
 
enum class SampleHeritageRuntimeStateStatus : std::uint8_t {
    Ok,
    NotPrepared,
    UnsupportedSchemaVersion,
    ProfileMismatch,
    InvalidStageLayout,
    InvalidRandomState,
    InvalidSlotLayout,
    InvalidHostSampleRate,
};
 
struct SampleHeritageRuntimeStateCapture {
    SampleHeritageRuntimeStateStatus status =
        SampleHeritageRuntimeStateStatus::NotPrepared;
    SampleHeritageRuntimeState state{};
 
    bool valid() const noexcept {
        return status == SampleHeritageRuntimeStateStatus::Ok;
    }
};
 
struct SampleHeritageTypedRuntimeStateCapture {
    SampleHeritageRuntimeStateStatus status =
        SampleHeritageRuntimeStateStatus::NotPrepared;
    SampleHeritageTypedRuntimeState state{};
 
    bool valid() const noexcept {
        return status == SampleHeritageRuntimeStateStatus::Ok;
    }
};
 
}  // namespace pulp::audio