voice_identity.hpp

Go to the documentation of this file.

#pragma once
 
// Value-only authored identity for graph voice-bank slots.  Runtime node
// handles, allocator indexes, epochs, and note generations are deliberately
// absent from this type and can never affect its encoding.
 
#include <cstdint>
#include <string>
#include <vector>
 
namespace pulp::host {
 
enum class VoicePortDirection : std::uint8_t { Input = 0, Output = 1 };
enum class VoicePortKind : std::uint8_t { Audio = 0, Event = 1, Control = 2 };
 
struct VoicePortKey {
    VoicePortDirection direction = VoicePortDirection::Input;
    VoicePortKind kind = VoicePortKind::Audio;
    std::uint32_t ordinal = 0;
};

struct VoiceIdentityKey {
    std::string template_namespace;
    std::string template_name;
    std::uint32_t template_revision = 0;
    std::uint32_t bank_schema_version = 1;
    std::uint32_t slot_ordinal = 0;
    std::vector<std::string> path;
    bool has_port = false;
    VoicePortKey port{};
    bool has_parameter = false;
    std::string parameter;
};
 
struct VoiceIdentityResult {
    bool valid = false;
    std::vector<std::uint8_t> encoding;
    std::string sha256;
    std::string error;
};

VoiceIdentityResult canonical_voice_identity(const VoiceIdentityKey& key);
 
} // namespace pulp::host