plugin_state_io.hpp File Reference

#include <cstdint>
#include <functional>
#include <span>
#include <vector>

Go to the source code of this file.

Classes
struct	pulp::format::plugin_state_io::RestoreDiagnosticPolicy
struct	pulp::format::plugin_state_io::RestoreDiagnostics

Namespaces
namespace	pulp
namespace	pulp::state
	SequencerStateChannel is the audio-safe transport for a plugin's structured NON-parameter state: the bulk, observable state a step sequencer / mod-matrix / pattern engine holds outside its automatable parameter set (e.g.
namespace	pulp::format
	What the product grants a device: the quota table indexed by capability tier and live thermal state.
namespace	pulp::format::plugin_state_io

Typedefs
using	pulp::format::plugin_state_io::EnvelopeMigrationFn

Enumerations
enum class	pulp::format::plugin_state_io::RestoreBlobFormat : uint8_t { pulp::format::plugin_state_io::unknown , pulp::format::plugin_state_io::legacy_state_store , pulp::format::plugin_state_io::envelope }
enum class	pulp::format::plugin_state_io::RestoreDiagnosticStatus : uint8_t {   pulp::format::plugin_state_io::ok , pulp::format::plugin_state_io::empty_blob , pulp::format::plugin_state_io::unknown_format , pulp::format::plugin_state_io::truncated_envelope ,   pulp::format::plugin_state_io::unsupported_envelope_version , pulp::format::plugin_state_io::envelope_migration_unavailable , pulp::format::plugin_state_io::payload_size_mismatch , pulp::format::plugin_state_io::crc_mismatch ,   pulp::format::plugin_state_io::empty_store_payload , pulp::format::plugin_state_io::total_size_budget_exceeded , pulp::format::plugin_state_io::store_size_budget_exceeded , pulp::format::plugin_state_io::plugin_size_budget_exceeded }

Functions
uint32_t	pulp::format::plugin_state_io::current_envelope_version ()
const char *	pulp::format::plugin_state_io::restore_diagnostic_status_name (RestoreDiagnosticStatus status) noexcept
RestoreDiagnostics	pulp::format::plugin_state_io::inspect_restore_blob (std::span< const uint8_t > bytes, const RestoreDiagnosticPolicy &policy={}) noexcept
	Inspect a host-facing plugin state blob without mutating live plugin state.
bool	pulp::format::plugin_state_io::register_envelope_migration (uint32_t from_version, uint32_t to_version, EnvelopeMigrationFn migration)
std::vector< uint8_t >	pulp::format::plugin_state_io::serialize (const state::StateStore &store, const Processor &processor)
	Serialize the host-facing plugin state blob for a Processor.
bool	pulp::format::plugin_state_io::deserialize (std::span< const uint8_t > bytes, state::StateStore &store, Processor &processor)
	Restore a host-facing plugin state blob.