record-descriptor 0.1.6

//! Public Bitneedle BRD1 descriptor wire-format and decoding primitives.
//!
//! This crate is the authoritative BRD1 carrier-descriptor wire contract. It
//! describes how the record stream is located and encoded in the PNG carrier.
//! It does not define BRS1 payload-entry semantics, programme-time revolution
//! duration, track timing, GAP timing, or the relationship between payload
//! entries and programme revolutions.
//!
//! It contains no JSON descriptor segments, no Brotli compatibility envelopes,
//! no base64/hex wire representations, and no record-creation policy.

use anyhow::{bail, Context, Result};
use base64::{engine::general_purpose::URL_SAFE_NO_PAD, Engine as _};
use chacha20poly1305::aead::{Aead, KeyInit, Payload as AeadPayload};
use chacha20poly1305::{Key, XChaCha20Poly1305, XNonce};
use serde::{Deserialize, Serialize};
use sha2::{Digest, Sha256};
use std::convert::TryInto;

pub const RECORD_DESCRIPTOR_MAGIC: &[u8; 4] = b"BRD1";
pub const RECORD_DESCRIPTOR_VERSION: u8 = 2;
pub const RECORD_DESCRIPTOR_PREFIX_LENGTH: usize = 19;

pub const METADATA_GRAYSCALE_NIBBLE_BASE: u8 = 120;

/// Fixed by the BRD1 v2 format: release commitments are always SHA-256,
/// signatures are always Ed25519. No per-reference algorithm selector.
pub const SIGNED_RELEASE_REFERENCE_VERSION: u8 = 2;
pub const SIGNED_RELEASE_REFERENCE_HASH_LENGTH: usize = 32;
pub const SIGNED_RELEASE_REFERENCE_SIGNATURE_LENGTH: usize = 64;
pub const SIGNED_RELEASE_REFERENCE_MAX_KEY_ID_LENGTH: usize = u16::MAX as usize;

pub const CACHE_ENCRYPTION_DESCRIPTOR_VERSION: u8 = 1;
pub const CACHE_ENCRYPTION_ALGORITHM_XCHACHA20POLY1305: &str = "xchacha20-poly1305";
pub const CACHE_KEY_DERIVATION_HKDF_SHA256: &str = "hkdf-sha256";
pub const CACHE_ENCRYPTION_SECRET_LENGTH: usize = 32;
pub const CACHE_ENCRYPTION_RECORD_BINDING_HASH_LENGTH: usize = 32;
pub const CACHE_ENCRYPTION_NONCE_LENGTH: usize = 24;
pub const CACHE_ENCRYPTION_TAG_LENGTH: usize = 16;
pub const CACHE_ENCRYPTION_ENVELOPE_MAGIC: &[u8; 4] = b"BCE1";
pub const CACHE_ENCRYPTION_ENVELOPE_VERSION: u8 = 1;
pub const CACHE_ENCRYPTION_ENVELOPE_ALGORITHM_XCHACHA20POLY1305: u8 = 1;
pub const CACHE_ENCRYPTION_INFO: &[u8] = b"bitneedle-cache-encryption-v1";
pub const CACHE_ENCRYPTION_NONCE_INFO: &[u8] = b"bitneedle-cache-encryption-nonce-v1";
pub const CACHE_ENCRYPTION_AAD_DOMAIN: &[u8] = b"bitneedle-cache-encryption-aad-v1";
pub const CACHE_ENCRYPTION_NONCE_DOMAIN: &[u8] = b"bitneedle-cache-nonce-v1";

pub const RECORD_PROFILE_SINGLE45_CODE: u8 = 0;
pub const RECORD_PROFILE_LP_CODE: u8 = 1;
pub const RECORD_PROFILE_SINGLE45: &str = "single45";
pub const RECORD_PROFILE_LP: &str = "lp";

pub const RELEASE_ID_LENGTH: usize = 16;

pub const SEGMENT_DESCRIPTOR_CRC32: u8 = 1;
pub const SEGMENT_STREAM_BYTE_LENGTH: u8 = 2;
pub const SEGMENT_RECORD_PROFILE: u8 = 4;
pub const SEGMENT_TITLE: u8 = 5;
pub const SEGMENT_ARTIST: u8 = 6;
pub const SEGMENT_PAYLOAD_ENCODING: u8 = 7;
pub const SEGMENT_RELEASE_ID: u8 = 8;
pub const SEGMENT_CATALOG_NUMBER: u8 = 9;
pub const SEGMENT_LABEL: u8 = 10;
pub const SEGMENT_ARTWORK_CREDIT: u8 = 11;
pub const SEGMENT_CANONICAL_URL: u8 = 13;
pub const SEGMENT_CREATED_AT: u8 = 14;
pub const SEGMENT_SIGNED_RELEASE_REFERENCE: u8 = 16;
pub const SEGMENT_BSC_POINTER: u8 = 21;
pub const SEGMENT_TONED_CARRIER_MAP: u8 = 22;
pub const SEGMENT_CACHE_ENCRYPTION: u8 = 23;
pub const SEGMENT_COPYRIGHT_YEAR: u8 = 24;
pub const SEGMENT_COPYRIGHT_HOLDER: u8 = 25;

pub const PAYLOAD_ENCODING_RGB: &str = "rgb";
pub const PAYLOAD_ENCODING_TONED_V1: &str = "toned-v1";
pub const PAYLOAD_ENCODING_RGB_CODE: u8 = 0;
pub const PAYLOAD_ENCODING_TONED_V1_CODE: u8 = 1;

pub const TONED_CARRIER_MAP_VERSION: u8 = 1;
pub const TONED_ORDERING_BASE_PROXIMITY: u8 = 0;
pub const TONED_ORDERING_CHROMA_PROXIMITY: u8 = 1;
pub const TONED_MIN_BITS_PER_PIXEL: u8 = 1;
pub const TONED_MAX_BITS_PER_PIXEL: u8 = 24;
pub const TONED_MAX_SPAN_COUNT: usize = u16::MAX as usize;

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
pub enum CacheEncryptionAlgorithm {
    #[serde(rename = "xchacha20-poly1305")]
    XChaCha20Poly1305,
}

impl CacheEncryptionAlgorithm {
    pub fn wire_code(self) -> u8 {
        match self {
            Self::XChaCha20Poly1305 => CACHE_ENCRYPTION_ENVELOPE_ALGORITHM_XCHACHA20POLY1305,
        }
    }

    pub fn from_wire_code(code: u8) -> Result<Self> {
        match code {
            CACHE_ENCRYPTION_ENVELOPE_ALGORITHM_XCHACHA20POLY1305 => Ok(Self::XChaCha20Poly1305),
            _ => bail!("unsupported cache encryption algorithm code {code}"),
        }
    }
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
pub enum CacheKeyDerivation {
    #[serde(rename = "hkdf-sha256")]
    HkdfSha256,
}

impl CacheKeyDerivation {
    pub fn wire_code(self) -> u8 {
        match self {
            Self::HkdfSha256 => 1,
        }
    }

    pub fn from_wire_code(code: u8) -> Result<Self> {
        match code {
            1 => Ok(Self::HkdfSha256),
            _ => bail!("unsupported cache key derivation code {code}"),
        }
    }
}

fn serialize_secret_base64url<S>(secret: &Vec<u8>, serializer: S) -> Result<S::Ok, S::Error>
where
    S: serde::Serializer,
{
    serializer.serialize_str(&URL_SAFE_NO_PAD.encode(secret))
}

fn deserialize_secret_base64url<'de, D>(deserializer: D) -> Result<Vec<u8>, D::Error>
where
    D: serde::Deserializer<'de>,
{
    let text = String::deserialize(deserializer)?;
    URL_SAFE_NO_PAD
        .decode(text.as_bytes())
        .map_err(serde::de::Error::custom)
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct CacheEncryptionDescriptor {
    pub version: u8,
    pub algorithm: CacheEncryptionAlgorithm,
    pub key_derivation: CacheKeyDerivation,
    #[serde(
        serialize_with = "serialize_secret_base64url",
        deserialize_with = "deserialize_secret_base64url"
    )]
    pub secret: Vec<u8>,
}

impl CacheEncryptionDescriptor {
    pub fn validate(&self) -> Result<()> {
        if self.version != CACHE_ENCRYPTION_DESCRIPTOR_VERSION {
            bail!(
                "unsupported cache encryption descriptor version: {}",
                self.version
            );
        }
        match self.algorithm {
            CacheEncryptionAlgorithm::XChaCha20Poly1305 => {}
        }
        match self.key_derivation {
            CacheKeyDerivation::HkdfSha256 => {}
        }
        if self.secret.len() != CACHE_ENCRYPTION_SECRET_LENGTH {
            bail!(
                "cache encryption secret must be exactly {} bytes",
                CACHE_ENCRYPTION_SECRET_LENGTH
            );
        }
        Ok(())
    }

    pub fn secret(&self) -> &[u8] {
        self.secret.as_slice()
    }

    pub fn from_secret_base64url(secret: &str) -> Result<Self> {
        let secret = URL_SAFE_NO_PAD
            .decode(secret.as_bytes())
            .context("cache encryption secret is not valid base64url")?;
        let descriptor = Self {
            version: CACHE_ENCRYPTION_DESCRIPTOR_VERSION,
            algorithm: CacheEncryptionAlgorithm::XChaCha20Poly1305,
            key_derivation: CacheKeyDerivation::HkdfSha256,
            secret,
        };
        descriptor.validate()?;
        Ok(descriptor)
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct CacheEncryptionContext {
    pub protocol_version: u8,
    pub cache_format_version: u8,
    pub cache_store_name: String,
    pub cache_key: String,
    pub chunk_index: u64,
    pub packet_offset: u64,
    pub plaintext_length: usize,
    pub codec_identifier: String,
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct CacheEncryptionEnvelope {
    pub version: u8,
    pub algorithm: u8,
    pub flags: u16,
    pub record_binding_hash: [u8; CACHE_ENCRYPTION_RECORD_BINDING_HASH_LENGTH],
    pub chunk_index: u64,
    pub packet_offset: u64,
    pub plaintext_length: u32,
    pub nonce: [u8; CACHE_ENCRYPTION_NONCE_LENGTH],
    pub ciphertext: Vec<u8>,
}

impl CacheEncryptionEnvelope {
    pub const HEADER_LENGTH: usize = 4
        + 1
        + 1
        + 2
        + CACHE_ENCRYPTION_RECORD_BINDING_HASH_LENGTH
        + 8
        + 8
        + 4
        + CACHE_ENCRYPTION_NONCE_LENGTH;

    pub fn parse(bytes: &[u8]) -> Result<Self> {
        if bytes.len() < Self::HEADER_LENGTH + CACHE_ENCRYPTION_TAG_LENGTH {
            bail!("invalid BCE1 envelope: truncated header or ciphertext");
        }
        if bytes.get(0..4) != Some(CACHE_ENCRYPTION_ENVELOPE_MAGIC.as_slice()) {
            bail!("invalid BCE1 envelope: magic mismatch");
        }

        let version = bytes[4];
        if version != CACHE_ENCRYPTION_ENVELOPE_VERSION {
            bail!("unsupported BCE1 envelope version {version}");
        }

        let algorithm = bytes[5];
        if algorithm != CACHE_ENCRYPTION_ENVELOPE_ALGORITHM_XCHACHA20POLY1305 {
            bail!("unsupported BCE1 envelope algorithm {algorithm}");
        }

        let flags = u16::from_be_bytes(bytes[6..8].try_into().expect("slice length"));
        let record_binding_hash = bytes[8..40].try_into().expect("slice length");
        let chunk_index = u64::from_be_bytes(bytes[40..48].try_into().expect("slice length"));
        let packet_offset = u64::from_be_bytes(bytes[48..56].try_into().expect("slice length"));
        let plaintext_length = u32::from_be_bytes(bytes[56..60].try_into().expect("slice length"));
        let nonce = bytes[60..84].try_into().expect("slice length");
        let ciphertext = bytes[84..].to_vec();

        if plaintext_length == 0 {
            bail!("invalid BCE1 envelope: empty plaintext length");
        }
        if ciphertext.len() != plaintext_length as usize + CACHE_ENCRYPTION_TAG_LENGTH {
            bail!("invalid BCE1 envelope: ciphertext length mismatch");
        }

        Ok(Self {
            version,
            algorithm,
            flags,
            record_binding_hash,
            chunk_index,
            packet_offset,
            plaintext_length,
            nonce,
            ciphertext,
        })
    }

    pub fn encode(&self) -> Result<Vec<u8>> {
        if self.version != CACHE_ENCRYPTION_ENVELOPE_VERSION {
            bail!("unsupported BCE1 envelope version {}", self.version);
        }
        if self.algorithm != CACHE_ENCRYPTION_ENVELOPE_ALGORITHM_XCHACHA20POLY1305 {
            bail!("unsupported BCE1 envelope algorithm {}", self.algorithm);
        }
        if self.plaintext_length == 0 {
            bail!("invalid BCE1 envelope: empty plaintext length");
        }
        if self.ciphertext.len() != self.plaintext_length as usize + CACHE_ENCRYPTION_TAG_LENGTH {
            bail!("invalid BCE1 envelope: ciphertext length mismatch");
        }

        let mut out = Vec::with_capacity(Self::HEADER_LENGTH + self.ciphertext.len());
        out.extend_from_slice(CACHE_ENCRYPTION_ENVELOPE_MAGIC);
        out.push(self.version);
        out.push(self.algorithm);
        out.extend_from_slice(&self.flags.to_be_bytes());
        out.extend_from_slice(&self.record_binding_hash);
        out.extend_from_slice(&self.chunk_index.to_be_bytes());
        out.extend_from_slice(&self.packet_offset.to_be_bytes());
        out.extend_from_slice(&self.plaintext_length.to_be_bytes());
        out.extend_from_slice(&self.nonce);
        out.extend_from_slice(&self.ciphertext);
        Ok(out)
    }
}

fn push_u8(out: &mut Vec<u8>, value: u8) {
    out.push(value);
}

fn push_u16(out: &mut Vec<u8>, value: u16) {
    out.extend_from_slice(&value.to_be_bytes());
}

fn push_u32(out: &mut Vec<u8>, value: u32) {
    out.extend_from_slice(&value.to_be_bytes());
}

fn push_u64(out: &mut Vec<u8>, value: u64) {
    out.extend_from_slice(&value.to_be_bytes());
}

#[allow(dead_code)]
fn push_len_prefixed_bytes(out: &mut Vec<u8>, tag: u8, bytes: &[u8]) {
    out.push(tag);
    push_u32(out, u32::try_from(bytes.len()).unwrap_or(u32::MAX));
    out.extend_from_slice(bytes);
}

fn push_len_prefixed_string(out: &mut Vec<u8>, tag: u8, value: Option<&str>) {
    out.push(tag);
    match value {
        Some(value) => {
            let bytes = value.as_bytes();
            push_u32(out, u32::try_from(bytes.len()).unwrap_or(u32::MAX));
            out.extend_from_slice(bytes);
        }
        None => push_u32(out, 0),
    }
}

fn push_len_prefixed_u8_slice<const N: usize>(out: &mut Vec<u8>, tag: u8, value: Option<&[u8; N]>) {
    out.push(tag);
    match value {
        Some(value) => {
            push_u32(out, N as u32);
            out.extend_from_slice(value);
        }
        None => push_u32(out, 0),
    }
}

fn cache_encryption_identity_bytes(descriptor: &RecordDescriptor) -> Result<Vec<u8>> {
    let mut out = Vec::new();
    out.extend_from_slice(b"bitneedle.record-descriptor.cache-identity.v1");
    push_u8(&mut out, descriptor.version);
    push_u8(&mut out, u8::from(descriptor.checksum_protected));
    push_u64(&mut out, descriptor.b_value_bits);
    push_len_prefixed_string(&mut out, 1, Some(&descriptor.record_profile));
    push_u64(&mut out, descriptor.stream_byte_length as u64);
    push_len_prefixed_string(&mut out, 2, Some(&descriptor.payload_encoding));
    push_len_prefixed_string(&mut out, 3, descriptor.title.as_deref());
    push_len_prefixed_string(&mut out, 4, descriptor.artist.as_deref());
    push_len_prefixed_u8_slice(&mut out, 5, descriptor.release_id.as_ref());
    push_len_prefixed_string(&mut out, 6, descriptor.catalog_number.as_deref());
    push_len_prefixed_string(&mut out, 7, descriptor.label.as_deref());
    push_len_prefixed_string(&mut out, 8, descriptor.artwork_credit.as_deref());
    push_len_prefixed_string(&mut out, 9, descriptor.canonical_url.as_deref());
    out.push(10);
    match descriptor.created_at {
        Some(value) => {
            push_u32(&mut out, 8);
            push_u64(&mut out, value);
        }
        None => push_u32(&mut out, 0),
    }
    out.push(12);
    match descriptor.bsc_pointer.as_ref() {
        Some(pointer) => {
            push_u32(
                &mut out,
                u32::try_from(pointer.len()).context("BSC pointer exceeds u32")?,
            );
            out.extend_from_slice(pointer);
        }
        None => push_u32(&mut out, 0),
    }
    out.push(13);
    push_u32(
        &mut out,
        u32::try_from(descriptor.tone_spans.len()).context("tone span count exceeds u32")?,
    );
    for span in &descriptor.tone_spans {
        push_u32(
            &mut out,
            u32::try_from(span.byte_length).context("tone span byte length exceeds u32")?,
        );
        out.extend_from_slice(&span.base);
        push_u8(&mut out, span.luma_tolerance);
        push_u8(&mut out, span.bits_per_pixel);
        push_u8(&mut out, span.ordering.wire_code());
    }
    out.push(14);
    match descriptor.copyright_year {
        Some(value) => {
            push_u32(&mut out, 2);
            push_u16(&mut out, value);
        }
        None => push_u32(&mut out, 0),
    }
    push_len_prefixed_string(&mut out, 15, descriptor.copyright_holder.as_deref());
    Ok(out)
}

pub fn cache_encryption_record_binding_hash(
    descriptor: &RecordDescriptor,
) -> Result<[u8; CACHE_ENCRYPTION_RECORD_BINDING_HASH_LENGTH]> {
    let identity = cache_encryption_identity_bytes(descriptor)?;
    Ok(Sha256::digest(identity).into())
}

pub fn derive_cache_encryption_key(descriptor: &RecordDescriptor) -> Result<[u8; 32]> {
    let cache_encryption = descriptor
        .cache_encryption
        .as_ref()
        .context("record descriptor is missing cache encryption descriptor")?;
    cache_encryption.validate()?;

    let salt = cache_encryption_record_binding_hash(descriptor)?;
    Ok(hkdf_sha256_32(
        &salt,
        cache_encryption.secret(),
        CACHE_ENCRYPTION_INFO,
    ))
}

/// Subkey used only to derive the per-entry nonce, kept separate from the AEAD
/// key itself (same salt/secret, distinct HKDF `info` label).
fn derive_cache_nonce_key(descriptor: &RecordDescriptor) -> Result<[u8; 32]> {
    let cache_encryption = descriptor
        .cache_encryption
        .as_ref()
        .context("record descriptor is missing cache encryption descriptor")?;
    cache_encryption.validate()?;

    let salt = cache_encryption_record_binding_hash(descriptor)?;
    Ok(hkdf_sha256_32(
        &salt,
        cache_encryption.secret(),
        CACHE_ENCRYPTION_NONCE_INFO,
    ))
}

/// Deterministic nonce: a PRF over the plaintext (hashed) and enough of the
/// cache context to disambiguate entries, keyed by a subkey derived from the
/// record's own cache-encryption secret. The same (record, plaintext, context)
/// always produces the same nonce, so the same triple always produces
/// byte-identical ciphertext — this is what makes the resulting BCE1 envelope
/// safe to use as a content-addressed cache key, and what two independent
/// writers (e.g. press after issuance, then a player's own first decode)
/// converge on. Nonce reuse under a fixed key only ever happens for identical
/// plaintext, which is the intended convergent-encryption property here, not a
/// confidentiality regression: the plaintext (decoded audio) is already fully
/// recoverable by anyone holding the record image.
fn derive_cache_nonce(
    nonce_key: &[u8; 32],
    context: &CacheEncryptionContext,
    plaintext: &[u8],
) -> [u8; CACHE_ENCRYPTION_NONCE_LENGTH] {
    let plaintext_hash: [u8; 32] = Sha256::digest(plaintext).into();
    let mut input =
        Vec::with_capacity(CACHE_ENCRYPTION_NONCE_DOMAIN.len() + 32 + context.cache_key.len() + 20);
    input.extend_from_slice(CACHE_ENCRYPTION_NONCE_DOMAIN);
    input.extend_from_slice(&plaintext_hash);
    push_len_prefixed_string(&mut input, 1, Some(&context.cache_key));
    push_u64(&mut input, context.chunk_index);
    push_u64(&mut input, context.packet_offset);
    let mac = hmac_sha256(nonce_key, &input);
    let mut nonce = [0u8; CACHE_ENCRYPTION_NONCE_LENGTH];
    nonce.copy_from_slice(&mac[..CACHE_ENCRYPTION_NONCE_LENGTH]);
    nonce
}

fn hex_encode(bytes: &[u8]) -> String {
    const HEX_DIGITS: &[u8; 16] = b"0123456789abcdef";
    let mut out = String::with_capacity(bytes.len() * 2);
    for byte in bytes {
        out.push(HEX_DIGITS[(byte >> 4) as usize] as char);
        out.push(HEX_DIGITS[(byte & 0x0f) as usize] as char);
    }
    out
}

/// Hex-encoded record binding hash, exposed so callers (e.g. the JS cache
/// layer, via the wasm bindings) can fold the exact same record-identity
/// notion the encryption itself uses into a pre-decode, record-scoped cache
/// lookup key, without reimplementing the identity hash.
pub fn cache_encryption_record_binding_hash_hex(descriptor: &RecordDescriptor) -> Result<String> {
    Ok(hex_encode(&cache_encryption_record_binding_hash(
        descriptor,
    )?))
}

fn hmac_sha256(key: &[u8], data: &[u8]) -> [u8; 32] {
    const BLOCK_SIZE: usize = 64;
    let mut key_block = [0u8; BLOCK_SIZE];
    if key.len() > BLOCK_SIZE {
        let hashed: [u8; 32] = Sha256::digest(key).into();
        key_block[..hashed.len()].copy_from_slice(&hashed);
    } else {
        key_block[..key.len()].copy_from_slice(key);
    }

    let mut inner_pad = [0u8; BLOCK_SIZE];
    let mut outer_pad = [0u8; BLOCK_SIZE];
    for index in 0..BLOCK_SIZE {
        inner_pad[index] = key_block[index] ^ 0x36;
        outer_pad[index] = key_block[index] ^ 0x5c;
    }

    let mut inner = Sha256::new();
    inner.update(inner_pad);
    inner.update(data);
    let inner_digest = inner.finalize();

    let mut outer = Sha256::new();
    outer.update(outer_pad);
    outer.update(inner_digest);
    outer.finalize().into()
}

fn hkdf_sha256_32(salt: &[u8], ikm: &[u8], info: &[u8]) -> [u8; 32] {
    let prk = hmac_sha256(salt, ikm);
    let mut okm_input = Vec::with_capacity(info.len() + 1);
    okm_input.extend_from_slice(info);
    okm_input.push(1);
    hmac_sha256(&prk, &okm_input)
}

pub fn cache_encryption_aad(
    descriptor: &RecordDescriptor,
    context: &CacheEncryptionContext,
) -> Result<Vec<u8>> {
    let binding_hash = cache_encryption_record_binding_hash(descriptor)?;
    let mut out = Vec::new();
    out.extend_from_slice(CACHE_ENCRYPTION_AAD_DOMAIN);
    push_u8(&mut out, context.protocol_version);
    push_u8(&mut out, context.cache_format_version);
    out.extend_from_slice(&binding_hash);
    push_len_prefixed_string(&mut out, 1, Some(&context.cache_store_name));
    push_len_prefixed_string(&mut out, 2, Some(&context.cache_key));
    push_u64(&mut out, context.chunk_index);
    push_u64(&mut out, context.packet_offset);
    push_u64(
        &mut out,
        u64::try_from(context.plaintext_length).context("plaintext length exceeds u64")?,
    );
    push_len_prefixed_string(&mut out, 3, Some(&context.codec_identifier));
    Ok(out)
}

pub fn encrypt_cache_envelope(
    descriptor: &RecordDescriptor,
    context: &CacheEncryptionContext,
    plaintext: &[u8],
) -> Result<Vec<u8>> {
    if plaintext.is_empty() {
        bail!("cache plaintext must not be empty");
    }
    if plaintext.len() != context.plaintext_length {
        bail!("cache plaintext length mismatch");
    }
    if !descriptor
        .cache_encryption
        .as_ref()
        .is_some_and(|value| value.validate().is_ok())
    {
        return Err(anyhow::anyhow!(
            "record descriptor is missing a valid cache encryption descriptor"
        ));
    }

    let key = derive_cache_encryption_key(descriptor)?;
    let nonce_key = derive_cache_nonce_key(descriptor)?;
    let nonce = derive_cache_nonce(&nonce_key, context, plaintext);
    let aad = cache_encryption_aad(descriptor, context)?;
    let ciphertext = XChaCha20Poly1305::new(Key::from_slice(&key))
        .encrypt(
            XNonce::from_slice(&nonce),
            AeadPayload {
                msg: plaintext,
                aad: &aad,
            },
        )
        .map_err(|_| anyhow::anyhow!("failed to encrypt cache payload"))?;

    let envelope = CacheEncryptionEnvelope {
        version: CACHE_ENCRYPTION_ENVELOPE_VERSION,
        algorithm: CACHE_ENCRYPTION_ENVELOPE_ALGORITHM_XCHACHA20POLY1305,
        flags: 0,
        record_binding_hash: cache_encryption_record_binding_hash(descriptor)?,
        chunk_index: context.chunk_index,
        packet_offset: context.packet_offset,
        plaintext_length: u32::try_from(plaintext.len()).context("plaintext length exceeds u32")?,
        nonce,
        ciphertext,
    };
    envelope.encode()
}

pub fn decrypt_cache_envelope(
    descriptor: &RecordDescriptor,
    context: &CacheEncryptionContext,
    envelope_bytes: &[u8],
) -> Result<Vec<u8>> {
    let envelope = CacheEncryptionEnvelope::parse(envelope_bytes)?;
    let expected_binding_hash = cache_encryption_record_binding_hash(descriptor)?;
    if envelope.record_binding_hash != expected_binding_hash {
        bail!("record binding hash mismatch");
    }
    let mut resolved_context = context.clone();
    resolved_context.chunk_index = envelope.chunk_index;
    resolved_context.packet_offset = envelope.packet_offset;
    resolved_context.plaintext_length = envelope.plaintext_length as usize;
    let key = derive_cache_encryption_key(descriptor)?;
    let aad = cache_encryption_aad(descriptor, &resolved_context)?;
    XChaCha20Poly1305::new(Key::from_slice(&key))
        .decrypt(
            XNonce::from_slice(&envelope.nonce),
            AeadPayload {
                msg: &envelope.ciphertext,
                aad: &aad,
            },
        )
        .map_err(|_| anyhow::anyhow!("cache authentication failed"))
}

#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub enum ToneOrdering {
    BaseProximity,
    ChromaProximity,
}

impl ToneOrdering {
    pub fn wire_code(self) -> u8 {
        match self {
            Self::BaseProximity => TONED_ORDERING_BASE_PROXIMITY,
            Self::ChromaProximity => TONED_ORDERING_CHROMA_PROXIMITY,
        }
    }

    pub fn from_wire_code(code: u8) -> Result<Self> {
        match code {
            TONED_ORDERING_BASE_PROXIMITY => Ok(Self::BaseProximity),
            TONED_ORDERING_CHROMA_PROXIMITY => Ok(Self::ChromaProximity),
            _ => bail!("unknown toned carrier ordering code {code}"),
        }
    }
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ToneSpanDescriptor {
    pub byte_length: usize,
    pub base: [u8; 3],
    pub luma_tolerance: u8,
    pub bits_per_pixel: u8,
    pub ordering: ToneOrdering,
}

#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct ResolvedToneSpan {
    pub index: usize,
    pub byte_offset: usize,
    pub byte_length: usize,
    pub pixel_offset: usize,
    pub pixel_count: usize,
    pub base: [u8; 3],
    pub luma_tolerance: u8,
    pub bits_per_pixel: u8,
    pub ordering: ToneOrdering,
}

/// One blanket signed-release reference covering the release commitment
/// (see `record_core::commitment::release_commitment`). SHA-256 and Ed25519
/// are fixed by `SIGNED_RELEASE_REFERENCE_VERSION`; there is no per-reference
/// algorithm selector.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct SignedReleaseReference {
    pub version: u8,
    pub release_commitment_sha256: [u8; SIGNED_RELEASE_REFERENCE_HASH_LENGTH],
    pub key_id: Vec<u8>,
    pub signature: Vec<u8>,
}

impl SignedReleaseReference {
    pub fn validate(&self) -> Result<()> {
        if self.version != SIGNED_RELEASE_REFERENCE_VERSION {
            bail!(
                "unsupported signed release reference version: {}",
                self.version
            );
        }
        if self.key_id.is_empty() {
            bail!("signature key ID must not be empty");
        }
        if self.key_id.len() > SIGNED_RELEASE_REFERENCE_MAX_KEY_ID_LENGTH {
            bail!("signature key ID exceeds u16 length limit");
        }
        if self.signature.len() != SIGNED_RELEASE_REFERENCE_SIGNATURE_LENGTH {
            bail!("signature must be exactly {SIGNED_RELEASE_REFERENCE_SIGNATURE_LENGTH} bytes");
        }
        Ok(())
    }
}

pub fn encode_cache_encryption_descriptor(
    cache_encryption: &CacheEncryptionDescriptor,
) -> Result<Vec<u8>> {
    cache_encryption.validate()?;
    let mut out = Vec::with_capacity(4 + CACHE_ENCRYPTION_SECRET_LENGTH);
    out.push(cache_encryption.version);
    out.push(cache_encryption.algorithm.wire_code());
    out.push(cache_encryption.key_derivation.wire_code());
    out.push(
        u8::try_from(cache_encryption.secret.len())
            .context("cache encryption secret exceeds u8")?,
    );
    out.extend_from_slice(cache_encryption.secret());
    Ok(out)
}

pub fn decode_cache_encryption_descriptor(bytes: &[u8]) -> Result<CacheEncryptionDescriptor> {
    if bytes.len() < 4 {
        bail!("cache encryption descriptor is truncated");
    }
    let version = bytes[0];
    let algorithm = CacheEncryptionAlgorithm::from_wire_code(bytes[1])?;
    let key_derivation = CacheKeyDerivation::from_wire_code(bytes[2])?;
    let secret_len = usize::from(bytes[3]);
    let secret = bytes[4..].to_vec();
    if secret_len != secret.len() {
        bail!("cache encryption secret length mismatch");
    }
    let descriptor = CacheEncryptionDescriptor {
        version,
        algorithm,
        key_derivation,
        secret,
    };
    descriptor.validate()?;
    Ok(descriptor)
}

/// Decoded BRD1 carrier descriptor.
///
/// `record_profile` identifies the canonical Bitneedle carrier profile used to
/// decode the raster geometry. BRD1 does not use this field to assign logical
/// sample counts to BRS1 payload entries; programme timing belongs to BRS1 and
/// codec-specific validation.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct RecordDescriptor {
    pub version: u8,
    pub checksum_protected: bool,
    pub b_value_bits: u64,
    pub record_profile: String,
    pub stream_byte_length: usize,
    pub payload_encoding: String,
    pub title: Option<String>,
    pub artist: Option<String>,
    pub release_id: Option<[u8; RELEASE_ID_LENGTH]>,
    pub catalog_number: Option<String>,
    pub label: Option<String>,
    pub artwork_credit: Option<String>,
    pub canonical_url: Option<String>,
    pub created_at: Option<u64>,
    /// Phonographic (℗) copyright year — the P-line year shown in credits.
    pub copyright_year: Option<u16>,
    /// Phonographic (℗) copyright holder text (e.g. the artist, optionally with
    /// a licensing clause). Distinct from `label` (the record label).
    pub copyright_holder: Option<String>,
    pub signed_release_reference: Option<SignedReleaseReference>,
    pub bsc_pointer: Option<Vec<u8>>,
    pub tone_spans: Vec<ToneSpanDescriptor>,
    pub cache_encryption: Option<CacheEncryptionDescriptor>,
}

impl RecordDescriptor {
    pub fn b_value(&self) -> f64 {
        f64::from_bits(self.b_value_bits)
    }

    pub fn cache_encryption(&self) -> Option<&CacheEncryptionDescriptor> {
        self.cache_encryption.as_ref()
    }

    pub fn validate_cache_encryption(&self) -> Result<()> {
        if let Some(cache_encryption) = self.cache_encryption.as_ref() {
            cache_encryption.validate()?;
        }
        Ok(())
    }
}

#[derive(Debug, Clone, PartialEq, Eq)]
pub struct DescriptorPrefix {
    pub version: u8,
    pub payload_len: usize,
    pub segment_count: usize,
    pub segment_stream_len: usize,
    pub b_value_bits: u64,
}

pub fn metadata_pixel_count_for_byte_length(byte_length: usize) -> usize {
    byte_length.saturating_mul(2)
}

pub fn metadata_byte_capacity_for_pixel_count(pixel_count: usize) -> usize {
    pixel_count / 2
}

pub fn metadata_bytes_from_grayscale_rgba(
    rgba: &[u8],
    indices: &[usize],
    byte_length: usize,
    label: &str,
) -> Result<Vec<u8>> {
    let pixel_count = metadata_pixel_count_for_byte_length(byte_length);
    if indices.len() < pixel_count {
        bail!("{label} spiral capacity is too small");
    }

    let mut bytes = Vec::with_capacity(byte_length);
    for byte_number in 0..byte_length {
        let mut nibbles = [0u8; 2];
        for nibble_index in 0..2 {
            let pixel_index = indices[byte_number * 2 + nibble_index];
            let rgba_index = pixel_index
                .checked_mul(4)
                .context("metadata RGBA index overflow")?;
            if rgba_index + 3 >= rgba.len() {
                bail!("{label} spiral pixel index is outside RGBA buffer");
            }

            let red = rgba[rgba_index];
            let green = rgba[rgba_index + 1];
            let blue = rgba[rgba_index + 2];
            let alpha = rgba[rgba_index + 3];

            if alpha == 0 {
                bail!("{label} spiral pixel is empty");
            }
            if red != green || green != blue {
                bail!("{label} metadata pixel is not grayscale");
            }

            let nibble = red
                .checked_sub(METADATA_GRAYSCALE_NIBBLE_BASE)
                .context("metadata pixel is below grayscale nibble range")?;
            if nibble > 0x0f {
                bail!("{label} metadata pixel is outside grayscale nibble range");
            }
            nibbles[nibble_index] = nibble;
        }
        bytes.push((nibbles[0] << 4) | nibbles[1]);
    }
    Ok(bytes)
}

pub fn record_profile_code(record_profile: &str) -> Result<u8> {
    match record_profile {
        RECORD_PROFILE_SINGLE45 => Ok(RECORD_PROFILE_SINGLE45_CODE),
        RECORD_PROFILE_LP => Ok(RECORD_PROFILE_LP_CODE),
        other => bail!("unsupported canonical record profile {other}"),
    }
}

pub fn record_profile_from_code(code: u8) -> Result<String> {
    match code {
        RECORD_PROFILE_SINGLE45_CODE => Ok(RECORD_PROFILE_SINGLE45.to_string()),
        RECORD_PROFILE_LP_CODE => Ok(RECORD_PROFILE_LP.to_string()),
        other => bail!("unknown record profile code {other}"),
    }
}

pub fn payload_encoding_code(payload_encoding: &str) -> Result<u8> {
    match payload_encoding {
        PAYLOAD_ENCODING_RGB => Ok(PAYLOAD_ENCODING_RGB_CODE),
        PAYLOAD_ENCODING_TONED_V1 => Ok(PAYLOAD_ENCODING_TONED_V1_CODE),
        other => bail!("unsupported canonical payload encoding {other}"),
    }
}

pub fn payload_encoding_from_code(code: u8) -> Result<String> {
    match code {
        PAYLOAD_ENCODING_RGB_CODE => Ok(PAYLOAD_ENCODING_RGB.to_string()),
        PAYLOAD_ENCODING_TONED_V1_CODE => Ok(PAYLOAD_ENCODING_TONED_V1.to_string()),
        other => bail!("unknown payload encoding code {other}"),
    }
}

const RELEASE_ID_TAGGED_PREFIX: &str = "rel_";
const RELEASE_ID_ULID_TEXT_LENGTH: usize = 26;
const CROCKFORD_BASE32: &[u8; 32] = b"0123456789ABCDEFGHJKMNPQRSTVWXYZ";

/// Parse a canonical `rel_`-tagged ULID string into its 16 raw bytes.
pub fn release_id_to_bytes(text: &str) -> Result<[u8; RELEASE_ID_LENGTH]> {
    let ulid_text = text
        .strip_prefix(RELEASE_ID_TAGGED_PREFIX)
        .context("release ID is missing the rel_ prefix")?;
    if ulid_text.len() != RELEASE_ID_ULID_TEXT_LENGTH {
        bail!("release ID must be 26 Crockford Base32 characters");
    }

    let mut bits: u128 = 0;
    for (index, byte) in ulid_text.bytes().enumerate() {
        let upper = byte.to_ascii_uppercase();
        let digit = CROCKFORD_BASE32
            .iter()
            .position(|&candidate| candidate == upper)
            .context("release ID contains a non-canonical Crockford Base32 character")?;

        // A textual ULID contains 130 encoded bits but the value is only
        // 128 bits. Therefore the first Crockford digit may contain only the
        // low two bits (0..=7). Rejecting larger values prevents silent u128
        // truncation and ensures one canonical text representation per value.
        if index == 0 && digit > 7 {
            bail!("release ID exceeds the 128-bit ULID range");
        }

        bits = (bits << 5) | digit as u128;
    }
    Ok(bits.to_be_bytes())
}

/// Format 16 raw release ULID bytes back into the canonical `rel_`-tagged
/// display string.
pub fn release_id_to_text(bytes: [u8; RELEASE_ID_LENGTH]) -> String {
    let mut value = u128::from_be_bytes(bytes);
    let mut chars = [b'0'; RELEASE_ID_ULID_TEXT_LENGTH];
    for index in (0..RELEASE_ID_ULID_TEXT_LENGTH).rev() {
        chars[index] = CROCKFORD_BASE32[(value & 0x1f) as usize];
        value >>= 5;
    }
    let mut text =
        String::with_capacity(RELEASE_ID_TAGGED_PREFIX.len() + RELEASE_ID_ULID_TEXT_LENGTH);
    text.push_str(RELEASE_ID_TAGGED_PREFIX);
    text.push_str(std::str::from_utf8(&chars).expect("Crockford Base32 alphabet is ASCII"));
    text
}

pub fn decode_descriptor_prefix(bytes: &[u8]) -> Result<DescriptorPrefix> {
    if bytes.len() < RECORD_DESCRIPTOR_PREFIX_LENGTH {
        bail!("record descriptor payload too short");
    }
    if &bytes[..4] != RECORD_DESCRIPTOR_MAGIC {
        bail!("record descriptor magic mismatch");
    }

    let version = bytes[4];
    let payload_len = u16::from_be_bytes(bytes[5..7].try_into().expect("slice length")) as usize;
    let segment_count = u16::from_be_bytes(bytes[7..9].try_into().expect("slice length")) as usize;
    let segment_stream_len =
        u16::from_be_bytes(bytes[9..11].try_into().expect("slice length")) as usize;
    let b_value_bits = u64::from_be_bytes(bytes[11..19].try_into().expect("slice length"));

    if payload_len < RECORD_DESCRIPTOR_PREFIX_LENGTH || payload_len > bytes.len() {
        bail!("record descriptor payload length is invalid");
    }

    Ok(DescriptorPrefix {
        version,
        payload_len,
        segment_count,
        segment_stream_len,
        b_value_bits,
    })
}

pub fn validate_tone_span(span: &ToneSpanDescriptor, index: usize) -> Result<()> {
    if span.byte_length == 0 {
        bail!("tone span {index} byte length must be greater than zero");
    }
    if !(TONED_MIN_BITS_PER_PIXEL..=TONED_MAX_BITS_PER_PIXEL).contains(&span.bits_per_pixel) {
        bail!(
            "tone span {index} bits per pixel must be between {} and {}",
            TONED_MIN_BITS_PER_PIXEL,
            TONED_MAX_BITS_PER_PIXEL
        );
    }
    Ok(())
}

pub fn resolve_tone_spans(
    spans: &[ToneSpanDescriptor],
    expected_byte_length: Option<usize>,
) -> Result<Vec<ResolvedToneSpan>> {
    if spans.is_empty() {
        bail!("toned-v1 carrier map must contain at least one span");
    }
    if spans.len() > TONED_MAX_SPAN_COUNT {
        bail!("tone span count exceeds u16 range");
    }

    let mut byte_offset = 0usize;
    let mut pixel_offset = 0usize;
    let mut resolved = Vec::with_capacity(spans.len());

    for (index, span) in spans.iter().enumerate() {
        validate_tone_span(span, index)?;
        let bit_length = span
            .byte_length
            .checked_mul(8)
            .context("tone span bit length overflow")?;
        let pixel_count = bit_length.div_ceil(usize::from(span.bits_per_pixel));

        resolved.push(ResolvedToneSpan {
            index,
            byte_offset,
            byte_length: span.byte_length,
            pixel_offset,
            pixel_count,
            base: span.base,
            luma_tolerance: span.luma_tolerance,
            bits_per_pixel: span.bits_per_pixel,
            ordering: span.ordering,
        });

        byte_offset = byte_offset
            .checked_add(span.byte_length)
            .context("tone span total byte length overflow")?;
        pixel_offset = pixel_offset
            .checked_add(pixel_count)
            .context("tone span total pixel count overflow")?;
    }

    if let Some(expected) = expected_byte_length {
        if byte_offset != expected {
            bail!("tone spans cover {byte_offset} bytes, expected {expected}");
        }
    }

    Ok(resolved)
}

pub fn toned_pixel_count(
    spans: &[ToneSpanDescriptor],
    expected_byte_length: Option<usize>,
) -> Result<usize> {
    Ok(resolve_tone_spans(spans, expected_byte_length)?
        .last()
        .map(|span| span.pixel_offset + span.pixel_count)
        .unwrap_or(0))
}

pub fn encode_toned_carrier_map(
    spans: &[ToneSpanDescriptor],
    expected_byte_length: Option<usize>,
) -> Result<Vec<u8>> {
    resolve_tone_spans(spans, expected_byte_length)?;

    let mut out = Vec::new();
    out.push(TONED_CARRIER_MAP_VERSION);
    out.extend_from_slice(
        &u16::try_from(spans.len())
            .context("tone span count exceeds u16")?
            .to_be_bytes(),
    );

    for span in spans {
        push_varuint(
            &mut out,
            u64::try_from(span.byte_length).context("tone span byte length exceeds u64")?,
        );
        out.extend_from_slice(&span.base);
        out.push(span.luma_tolerance);
        out.push(span.bits_per_pixel);
        out.push(span.ordering.wire_code());
    }

    Ok(out)
}

pub fn decode_toned_carrier_map(
    bytes: &[u8],
    expected_byte_length: Option<usize>,
) -> Result<Vec<ToneSpanDescriptor>> {
    let mut cursor = ByteCursor::new(bytes);
    let version = cursor.read_u8("toned carrier map version")?;
    if version != TONED_CARRIER_MAP_VERSION {
        bail!("unsupported toned carrier map version {version}");
    }

    let count = usize::from(cursor.read_u16be("tone span count")?);
    if count == 0 {
        bail!("toned-v1 carrier map must contain at least one span");
    }

    let mut spans = Vec::with_capacity(count);
    for index in 0..count {
        let byte_length = usize::try_from(cursor.read_varuint("tone span byte length")?)
            .context("tone span byte length exceeds usize")?;
        let base = [
            cursor.read_u8("tone span base red")?,
            cursor.read_u8("tone span base green")?,
            cursor.read_u8("tone span base blue")?,
        ];
        let luma_tolerance = cursor.read_u8("tone span luma tolerance")?;
        let bits_per_pixel = cursor.read_u8("tone span bits per pixel")?;
        let ordering = ToneOrdering::from_wire_code(cursor.read_u8("tone span ordering")?)?;

        let span = ToneSpanDescriptor {
            byte_length,
            base,
            luma_tolerance,
            bits_per_pixel,
            ordering,
        };
        validate_tone_span(&span, index)?;
        spans.push(span);
    }

    if cursor.remaining() != 0 {
        bail!(
            "toned carrier map contains {} trailing bytes",
            cursor.remaining()
        );
    }

    resolve_tone_spans(&spans, expected_byte_length)?;
    Ok(spans)
}

fn push_varuint(out: &mut Vec<u8>, mut value: u64) {
    loop {
        let mut byte = (value & 0x7f) as u8;
        value >>= 7;
        if value != 0 {
            byte |= 0x80;
        }
        out.push(byte);
        if value == 0 {
            break;
        }
    }
}

pub fn decode_signed_release_reference(bytes: &[u8]) -> Result<SignedReleaseReference> {
    let mut cursor = ByteCursor::new(bytes);

    let version = cursor.read_u8("signed release reference version")?;
    let release_commitment_sha256 = cursor
        .read_bytes(
            SIGNED_RELEASE_REFERENCE_HASH_LENGTH,
            "release commitment SHA-256",
        )?
        .try_into()
        .expect("length checked");
    let key_id_len = cursor.read_u16be("signature key ID length")? as usize;
    let key_id = cursor.read_bytes(key_id_len, "signature key ID")?.to_vec();
    let signature = cursor
        .read_bytes(SIGNED_RELEASE_REFERENCE_SIGNATURE_LENGTH, "signature")?
        .to_vec();

    if cursor.remaining() != 0 {
        bail!(
            "signed release reference contains {} trailing bytes",
            cursor.remaining()
        );
    }

    let reference = SignedReleaseReference {
        version,
        release_commitment_sha256,
        key_id,
        signature,
    };
    reference.validate()?;
    Ok(reference)
}

pub fn decode_record_descriptor_bytes(bytes: &[u8]) -> Result<RecordDescriptor> {
    let prefix = decode_descriptor_prefix(bytes)?;

    if prefix.version != RECORD_DESCRIPTOR_VERSION {
        bail!("record descriptor version mismatch");
    }
    if prefix.payload_len != RECORD_DESCRIPTOR_PREFIX_LENGTH + prefix.segment_stream_len {
        bail!("record descriptor segment stream length mismatch");
    }

    let body = &bytes[RECORD_DESCRIPTOR_PREFIX_LENGTH..prefix.payload_len];
    let mut offset = 0usize;
    let mut parsed_segments = 0usize;

    let mut crc32_range = None;
    let mut crc32 = None;
    let mut stream_byte_length = None;
    let mut record_profile = None;
    let mut payload_encoding = None;
    let mut title = None;
    let mut artist = None;
    let mut release_id = None;
    let mut catalog_number = None;
    let mut label = None;
    let mut artwork_credit = None;
    let mut canonical_url = None;
    let mut created_at = None;
    let mut copyright_year = None;
    let mut copyright_holder = None;
    let mut signed_release_reference = None;
    let mut bsc_pointer = None;
    let mut tone_spans = None;
    let mut cache_encryption = None;

    while offset < body.len() {
        if parsed_segments >= prefix.segment_count {
            bail!("record descriptor contains more segments than declared");
        }
        if offset + 3 > body.len() {
            bail!("record descriptor segment is truncated");
        }

        let kind = body[offset];
        let len = u16::from_be_bytes(
            body[offset + 1..offset + 3]
                .try_into()
                .expect("slice length"),
        ) as usize;
        let payload_start = offset + 3;
        let payload_end = payload_start
            .checked_add(len)
            .context("record descriptor segment length overflow")?;
        if payload_end > body.len() {
            bail!("record descriptor segment payload is truncated");
        }

        let payload = &body[payload_start..payload_end];
        match kind {
            SEGMENT_DESCRIPTOR_CRC32 => {
                if crc32.is_some() {
                    bail!("duplicate record descriptor CRC32 segment");
                }
                if payload.len() != 4 {
                    bail!("record descriptor CRC32 segment has invalid length");
                }
                crc32 = Some(u32::from_be_bytes(
                    payload.try_into().expect("slice length"),
                ));
                let absolute_start = RECORD_DESCRIPTOR_PREFIX_LENGTH + payload_start;
                crc32_range = Some(absolute_start..absolute_start + payload.len());
            }
            SEGMENT_STREAM_BYTE_LENGTH => {
                if stream_byte_length.is_some() {
                    bail!("duplicate stream byte length segment");
                }
                if payload.len() != 4 {
                    bail!("stream byte length segment has invalid length");
                }
                let raw_len = u32::from_be_bytes(payload.try_into().expect("slice length"));
                if raw_len == 0 {
                    bail!("stream byte length must not be zero");
                }
                stream_byte_length = Some(raw_len as usize);
            }
            SEGMENT_RECORD_PROFILE => {
                if payload.len() != 1 {
                    bail!("record profile segment has invalid length");
                }
                assign_once(
                    &mut record_profile,
                    record_profile_from_code(payload[0])?,
                    "record profile",
                )?
            }
            SEGMENT_PAYLOAD_ENCODING => {
                if payload.len() != 1 {
                    bail!("payload encoding segment has invalid length");
                }
                assign_once(
                    &mut payload_encoding,
                    payload_encoding_from_code(payload[0])?,
                    "payload encoding",
                )?
            }
            SEGMENT_TITLE => {
                assign_once(&mut title, decode_optional_text(payload, "title")?, "title")?
            }
            SEGMENT_ARTIST => assign_once(
                &mut artist,
                decode_optional_text(payload, "artist")?,
                "artist",
            )?,
            SEGMENT_RELEASE_ID => {
                if payload.len() != RELEASE_ID_LENGTH {
                    bail!("release ID segment has invalid length");
                }
                assign_once(
                    &mut release_id,
                    <[u8; RELEASE_ID_LENGTH]>::try_from(payload).expect("length checked"),
                    "release ID",
                )?
            }
            SEGMENT_CATALOG_NUMBER => assign_once(
                &mut catalog_number,
                decode_optional_text(payload, "catalog number")?,
                "catalog number",
            )?,
            SEGMENT_LABEL => {
                assign_once(&mut label, decode_optional_text(payload, "label")?, "label")?
            }
            SEGMENT_ARTWORK_CREDIT => assign_once(
                &mut artwork_credit,
                decode_optional_text(payload, "artwork credit")?,
                "artwork credit",
            )?,
            SEGMENT_CANONICAL_URL => assign_once(
                &mut canonical_url,
                decode_optional_text(payload, "canonical URL")?,
                "canonical URL",
            )?,
            SEGMENT_CREATED_AT => {
                if payload.len() != 8 {
                    bail!("created-at segment has invalid length");
                }
                assign_once(
                    &mut created_at,
                    u64::from_be_bytes(payload.try_into().expect("slice length")),
                    "created-at timestamp",
                )?
            }
            SEGMENT_COPYRIGHT_YEAR => {
                if payload.len() != 2 {
                    bail!("copyright-year segment has invalid length");
                }
                assign_once(
                    &mut copyright_year,
                    u16::from_be_bytes(payload.try_into().expect("slice length")),
                    "copyright year",
                )?
            }
            SEGMENT_COPYRIGHT_HOLDER => assign_once(
                &mut copyright_holder,
                decode_optional_text(payload, "copyright holder")?,
                "copyright holder",
            )?,
            SEGMENT_SIGNED_RELEASE_REFERENCE => {
                if signed_release_reference.is_some() {
                    bail!("duplicate signed release reference segment");
                }
                signed_release_reference = Some(decode_signed_release_reference(payload)?);
            }
            SEGMENT_BSC_POINTER => {
                if bsc_pointer.is_some() {
                    bail!("duplicate BSC pointer segment");
                }
                if payload.is_empty() {
                    bail!("BSC pointer segment must not be empty");
                }
                bsc_pointer = Some(payload.to_vec());
            }
            SEGMENT_TONED_CARRIER_MAP => {
                if tone_spans.is_some() {
                    bail!("duplicate toned carrier map segment");
                }
                tone_spans = Some(decode_toned_carrier_map(payload, None)?);
            }
            SEGMENT_CACHE_ENCRYPTION => {
                if cache_encryption.is_some() {
                    bail!("duplicate cache encryption segment");
                }
                cache_encryption = Some(decode_cache_encryption_descriptor(payload)?);
            }
            _ => bail!("unsupported canonical record descriptor segment type {kind}"),
        }

        offset = payload_end;
        parsed_segments += 1;
    }

    if parsed_segments != prefix.segment_count {
        bail!(
            "record descriptor segment count mismatch: declared {}, parsed {}",
            prefix.segment_count,
            parsed_segments
        );
    }

    let expected = crc32.context("record descriptor CRC32 segment is missing")?;
    let range = crc32_range.context("record descriptor CRC32 segment is missing")?;
    let mut canonical = bytes[..prefix.payload_len].to_vec();
    canonical[range].fill(0);

    if compute_descriptor_crc32(&canonical) != expected {
        bail!("record descriptor CRC32 mismatch");
    }

    let b_value = f64::from_bits(prefix.b_value_bits);
    if !(b_value.is_finite() && b_value > 0.0) {
        bail!("decoded invalid b_value");
    }

    let record_profile = record_profile.context("record profile segment is missing")?;
    let stream_byte_length = stream_byte_length.context("stream byte length segment is missing")?;
    let payload_encoding = payload_encoding.context("payload encoding segment is missing")?;
    let tone_spans = tone_spans.unwrap_or_default();

    match payload_encoding.as_str() {
        PAYLOAD_ENCODING_RGB => {
            if !tone_spans.is_empty() {
                bail!("rgb payload encoding must not include a toned carrier map");
            }
        }
        PAYLOAD_ENCODING_TONED_V1 => {
            if tone_spans.is_empty() {
                bail!("toned-v1 payload encoding requires a toned carrier map");
            }
            resolve_tone_spans(&tone_spans, Some(stream_byte_length))?;
        }
        other => bail!("unsupported canonical payload encoding {other}"),
    }

    Ok(RecordDescriptor {
        version: prefix.version,
        checksum_protected: true,
        b_value_bits: prefix.b_value_bits,
        record_profile,
        stream_byte_length,
        payload_encoding,
        title: title.flatten(),
        artist: artist.flatten(),
        release_id,
        catalog_number: catalog_number.flatten(),
        label: label.flatten(),
        artwork_credit: artwork_credit.flatten(),
        canonical_url: canonical_url.flatten(),
        created_at,
        copyright_year,
        copyright_holder: copyright_holder.flatten(),
        signed_release_reference,
        bsc_pointer,
        tone_spans,
        cache_encryption,
    })
}

pub fn compute_descriptor_crc32(bytes: &[u8]) -> u32 {
    record_core::crc32_ieee(bytes)
}

fn decode_optional_text(payload: &[u8], label: &str) -> Result<Option<String>> {
    if payload.is_empty() {
        return Ok(None);
    }
    Ok(Some(decode_text(payload, label)?))
}

fn decode_text(payload: &[u8], label: &str) -> Result<String> {
    let value = String::from_utf8(payload.to_vec())
        .with_context(|| format!("record descriptor {label} is not valid UTF-8"))?;
    if value.chars().any(char::is_control) {
        bail!("record descriptor {label} contains control characters");
    }
    Ok(value)
}

fn assign_once<T>(destination: &mut Option<T>, value: T, label: &str) -> Result<()> {
    if destination.is_some() {
        bail!("duplicate {label} segment");
    }
    *destination = Some(value);
    Ok(())
}

#[derive(Clone, Copy)]
struct ByteCursor<'a> {
    bytes: &'a [u8],
    offset: usize,
}

impl<'a> ByteCursor<'a> {
    fn new(bytes: &'a [u8]) -> Self {
        Self { bytes, offset: 0 }
    }

    fn remaining(self) -> usize {
        self.bytes.len().saturating_sub(self.offset)
    }

    fn read_u8(&mut self, label: &str) -> Result<u8> {
        let value = *self
            .bytes
            .get(self.offset)
            .with_context(|| format!("{label} is truncated"))?;
        self.offset += 1;
        Ok(value)
    }

    fn read_u16be(&mut self, label: &str) -> Result<u16> {
        let end = self
            .offset
            .checked_add(2)
            .with_context(|| format!("{label} offset overflow"))?;
        let bytes = self
            .bytes
            .get(self.offset..end)
            .with_context(|| format!("{label} is truncated"))?;
        self.offset = end;
        Ok(u16::from_be_bytes(
            bytes.try_into().expect("length checked"),
        ))
    }

    fn read_varuint(&mut self, label: &str) -> Result<u64> {
        let start = self.offset;
        let mut value = 0u64;
        let mut shift = 0u32;

        for byte_index in 0..10 {
            let byte = self.read_u8(label)?;
            let payload = u64::from(byte & 0x7f);

            if shift == 63 && payload > 1 {
                bail!("{label} exceeds u64 range");
            }

            value |= payload
                .checked_shl(shift)
                .with_context(|| format!("{label} shift overflow"))?;

            if byte & 0x80 == 0 {
                let consumed = self.offset - start;
                if consumed > 1 {
                    let minimum = 1u64 << (7 * (consumed - 1));
                    if value < minimum {
                        bail!("{label} uses non-canonical overlong varuint encoding");
                    }
                }
                return Ok(value);
            }

            shift += 7;
            if byte_index == 9 {
                bail!("{label} exceeds ten-byte varuint limit");
            }
        }

        unreachable!()
    }

    fn read_bytes(&mut self, length: usize, label: &str) -> Result<&'a [u8]> {
        let end = self
            .offset
            .checked_add(length)
            .with_context(|| format!("{label} length overflow"))?;
        let bytes = self
            .bytes
            .get(self.offset..end)
            .with_context(|| format!("{label} is truncated"))?;
        self.offset = end;
        Ok(bytes)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use base64::engine::general_purpose::URL_SAFE_NO_PAD;

    fn test_descriptor(secret: Vec<u8>) -> RecordDescriptor {
        RecordDescriptor {
            version: RECORD_DESCRIPTOR_VERSION,
            checksum_protected: true,
            b_value_bits: 1.0f64.to_bits(),
            record_profile: RECORD_PROFILE_SINGLE45.to_string(),
            stream_byte_length: 4096,
            payload_encoding: PAYLOAD_ENCODING_RGB.to_string(),
            title: Some("Title".to_string()),
            artist: Some("Artist".to_string()),
            release_id: Some([0x11; RELEASE_ID_LENGTH]),
            catalog_number: Some("CAT-1".to_string()),
            label: Some("Label".to_string()),
            artwork_credit: Some("Credit".to_string()),
            canonical_url: Some("https://example.invalid/release".to_string()),
            created_at: Some(1_700_000_000),
            copyright_year: Some(2006),
            copyright_holder: Some("Artist".to_string()),
            signed_release_reference: None,
            bsc_pointer: Some(vec![1, 2, 3, 4]),
            tone_spans: Vec::new(),
            cache_encryption: Some(CacheEncryptionDescriptor {
                version: CACHE_ENCRYPTION_DESCRIPTOR_VERSION,
                algorithm: CacheEncryptionAlgorithm::XChaCha20Poly1305,
                key_derivation: CacheKeyDerivation::HkdfSha256,
                secret,
            }),
        }
    }

    fn test_context() -> CacheEncryptionContext {
        CacheEncryptionContext {
            protocol_version: 1,
            cache_format_version: 1,
            cache_store_name: "opus-chunks".to_string(),
            cache_key: "0123456789abcdef".to_string(),
            chunk_index: 7,
            packet_offset: 2048,
            plaintext_length: 12,
            codec_identifier: "soundkit_opus_packets".to_string(),
        }
    }

    #[test]
    fn record_profile_codes_round_trip() {
        assert_eq!(record_profile_code("single45").unwrap(), 0);
        assert_eq!(record_profile_code("lp").unwrap(), 1);
        assert_eq!(record_profile_from_code(0).unwrap(), "single45");
        assert_eq!(record_profile_from_code(1).unwrap(), "lp");
        assert!(record_profile_from_code(2).is_err());
    }

    #[test]
    fn payload_encoding_codes_round_trip() {
        assert_eq!(payload_encoding_code("rgb").unwrap(), 0);
        assert_eq!(payload_encoding_code("toned-v1").unwrap(), 1);
        assert_eq!(payload_encoding_from_code(0).unwrap(), "rgb");
        assert_eq!(payload_encoding_from_code(1).unwrap(), "toned-v1");
        assert!(payload_encoding_from_code(2).is_err());
    }

    #[test]
    fn release_id_text_round_trips_through_bytes() {
        let bytes = [
            0x01, 0x23, 0x45, 0x67, 0x89, 0xab, 0xcd, 0xef, 0x10, 0x20, 0x30, 0x40, 0x50, 0x60,
            0x70, 0x80,
        ];
        let text = release_id_to_text(bytes);
        assert!(text.starts_with("rel_"));
        assert_eq!(text.len(), 4 + 26);
        assert_eq!(release_id_to_bytes(&text).unwrap(), bytes);
    }

    #[test]
    fn release_id_rejects_missing_prefix() {
        assert!(release_id_to_bytes("01ARZ3NDEKTSV4RRFFQ69G5FAV").is_err());
    }

    #[test]
    fn release_id_rejects_values_above_the_ulid_range() {
        assert!(release_id_to_bytes("rel_Z1ARZ3NDEKTSV4RRFFQ69G5FAV").is_err());
    }

    #[test]
    fn release_id_accepts_the_maximum_canonical_ulid() {
        let text = "rel_7ZZZZZZZZZZZZZZZZZZZZZZZZZ";
        let bytes = release_id_to_bytes(text).unwrap();
        assert_eq!(release_id_to_text(bytes), text);
    }

    #[test]
    fn binary_reference_round_trips_through_decoder() {
        let mut bytes = Vec::new();
        bytes.push(SIGNED_RELEASE_REFERENCE_VERSION);
        bytes.extend_from_slice(&[0x11; 32]);
        bytes.extend_from_slice(&3u16.to_be_bytes());
        bytes.extend_from_slice(b"key");
        bytes.extend_from_slice(&[0x22; 64]);

        let decoded = decode_signed_release_reference(&bytes).unwrap();
        assert_eq!(decoded.release_commitment_sha256, [0x11; 32]);
        assert_eq!(decoded.key_id, b"key");
        assert_eq!(decoded.signature, vec![0x22; 64]);
    }
    #[test]
    fn toned_carrier_map_round_trips() {
        let spans = vec![
            ToneSpanDescriptor {
                byte_length: 1024,
                base: [255, 192, 203],
                luma_tolerance: 16,
                bits_per_pixel: 21,
                ordering: ToneOrdering::ChromaProximity,
            },
            ToneSpanDescriptor {
                byte_length: 513,
                base: [20, 40, 80],
                luma_tolerance: 8,
                bits_per_pixel: 18,
                ordering: ToneOrdering::BaseProximity,
            },
        ];

        let bytes = encode_toned_carrier_map(&spans, Some(1537)).unwrap();
        let decoded = decode_toned_carrier_map(&bytes, Some(1537)).unwrap();

        assert_eq!(decoded, spans);
    }

    #[test]
    fn toned_offsets_are_derived() {
        let spans = vec![
            ToneSpanDescriptor {
                byte_length: 5,
                base: [1, 2, 3],
                luma_tolerance: 0,
                bits_per_pixel: 8,
                ordering: ToneOrdering::BaseProximity,
            },
            ToneSpanDescriptor {
                byte_length: 7,
                base: [4, 5, 6],
                luma_tolerance: 1,
                bits_per_pixel: 4,
                ordering: ToneOrdering::ChromaProximity,
            },
        ];

        let resolved = resolve_tone_spans(&spans, Some(12)).unwrap();
        assert_eq!(resolved[0].byte_offset, 0);
        assert_eq!(resolved[1].byte_offset, 5);
        assert_eq!(resolved[0].pixel_count, 5);
        assert_eq!(resolved[1].pixel_offset, 5);
        assert_eq!(resolved[1].pixel_count, 14);
    }

    #[test]
    fn toned_map_rejects_overlong_varuint() {
        let bytes = [
            TONED_CARRIER_MAP_VERSION,
            0,
            1,
            0x81,
            0x00,
            0,
            0,
            0,
            0,
            8,
            TONED_ORDERING_BASE_PROXIMITY,
        ];
        assert!(decode_toned_carrier_map(&bytes, None).is_err());
    }

    #[test]
    fn cache_encryption_descriptor_round_trips_through_json() {
        let descriptor = CacheEncryptionDescriptor {
            version: CACHE_ENCRYPTION_DESCRIPTOR_VERSION,
            algorithm: CacheEncryptionAlgorithm::XChaCha20Poly1305,
            key_derivation: CacheKeyDerivation::HkdfSha256,
            secret: vec![7u8; CACHE_ENCRYPTION_SECRET_LENGTH],
        };
        let json = serde_json::to_string(&descriptor).unwrap();
        let decoded: CacheEncryptionDescriptor = serde_json::from_str(&json).unwrap();
        assert_eq!(decoded, descriptor);
    }

    #[test]
    fn cache_encryption_secret_must_be_32_bytes() {
        let mut descriptor = CacheEncryptionDescriptor {
            version: CACHE_ENCRYPTION_DESCRIPTOR_VERSION,
            algorithm: CacheEncryptionAlgorithm::XChaCha20Poly1305,
            key_derivation: CacheKeyDerivation::HkdfSha256,
            secret: vec![0u8; 31],
        };
        assert!(descriptor.validate().is_err());
        descriptor.secret = vec![0u8; 32];
        assert!(descriptor.validate().is_ok());
    }

    #[test]
    fn cache_encryption_descriptor_rejects_malformed_base64url() {
        let json = r#"{"version":1,"algorithm":"xchacha20-poly1305","keyDerivation":"hkdf-sha256","secret":"not base64"}"#;
        assert!(serde_json::from_str::<CacheEncryptionDescriptor>(json).is_err());
    }

    #[test]
    fn cache_encryption_descriptor_rejects_wrong_secret_length() {
        let json = format!(
            r#"{{"version":1,"algorithm":"xchacha20-poly1305","keyDerivation":"hkdf-sha256","secret":"{}"}}"#,
            URL_SAFE_NO_PAD.encode([1u8; 31])
        );
        let parsed: CacheEncryptionDescriptor = serde_json::from_str(&json).unwrap();
        assert!(parsed.validate().is_err());
    }

    #[test]
    fn old_descriptors_without_cache_encryption_still_decode() {
        let descriptor = test_descriptor(vec![9u8; CACHE_ENCRYPTION_SECRET_LENGTH]);
        let json = serde_json::to_string(&descriptor).unwrap();
        let mut value: serde_json::Value = serde_json::from_str(&json).unwrap();
        value.as_object_mut().unwrap().remove("cacheEncryption");
        let decoded: RecordDescriptor = serde_json::from_value(value).unwrap();
        assert!(decoded.cache_encryption.is_none());
    }

    #[test]
    fn cache_encryption_key_derivation_is_stable_and_bindable() {
        let descriptor = test_descriptor(vec![1u8; CACHE_ENCRYPTION_SECRET_LENGTH]);
        let key_a = derive_cache_encryption_key(&descriptor).unwrap();
        let key_b = derive_cache_encryption_key(&descriptor).unwrap();
        assert_eq!(key_a, key_b);

        let mut other_secret = descriptor.clone();
        other_secret.cache_encryption.as_mut().unwrap().secret =
            vec![2u8; CACHE_ENCRYPTION_SECRET_LENGTH];
        assert_ne!(key_a, derive_cache_encryption_key(&other_secret).unwrap());

        let mut other_record = descriptor.clone();
        other_record.release_id = Some([0x22; RELEASE_ID_LENGTH]);
        assert_ne!(key_a, derive_cache_encryption_key(&other_record).unwrap());
    }

    #[test]
    fn cache_encryption_envelope_round_trips() {
        let descriptor = test_descriptor(vec![3u8; CACHE_ENCRYPTION_SECRET_LENGTH]);
        let context = test_context();
        let plaintext = b"opus-packets";
        let envelope = encrypt_cache_envelope(&descriptor, &context, plaintext).unwrap();
        let decrypted = decrypt_cache_envelope(&descriptor, &context, &envelope).unwrap();
        assert_eq!(decrypted, plaintext);
    }

    #[test]
    fn cache_encryption_envelope_rejects_tampering() {
        let descriptor = test_descriptor(vec![5u8; CACHE_ENCRYPTION_SECRET_LENGTH]);
        let context = test_context();
        let plaintext = b"opus-packets";
        let mut envelope = encrypt_cache_envelope(&descriptor, &context, plaintext).unwrap();

        envelope[CacheEncryptionEnvelope::HEADER_LENGTH] ^= 1;
        assert!(decrypt_cache_envelope(&descriptor, &context, &envelope).is_err());

        let mut nonce_tampered = encrypt_cache_envelope(&descriptor, &context, plaintext).unwrap();
        nonce_tampered[60] ^= 1;
        assert!(decrypt_cache_envelope(&descriptor, &context, &nonce_tampered).is_err());

        let mut binding_tampered =
            encrypt_cache_envelope(&descriptor, &context, plaintext).unwrap();
        binding_tampered[8] ^= 1;
        assert!(decrypt_cache_envelope(&descriptor, &context, &binding_tampered).is_err());
    }

    #[test]
    fn cache_encryption_nonce_is_deterministic_and_content_bound() {
        let descriptor = test_descriptor(vec![9u8; CACHE_ENCRYPTION_SECRET_LENGTH]);
        let context = test_context();
        let plaintext = b"opus-packets";

        let envelope_a = encrypt_cache_envelope(&descriptor, &context, plaintext).unwrap();
        let envelope_b = encrypt_cache_envelope(&descriptor, &context, plaintext).unwrap();
        assert_eq!(
            envelope_a, envelope_b,
            "same (record, plaintext, context) must produce byte-identical envelopes"
        );

        let other_plaintext = b"opus-packet$";
        assert_eq!(other_plaintext.len(), plaintext.len());
        let envelope_c = encrypt_cache_envelope(&descriptor, &context, other_plaintext).unwrap();
        assert_ne!(
            envelope_a, envelope_c,
            "different plaintext must not reuse the same nonce/ciphertext"
        );
    }

    #[test]
    fn cache_encryption_record_binding_hash_hex_differs_per_record() {
        let descriptor_a = test_descriptor(vec![1u8; CACHE_ENCRYPTION_SECRET_LENGTH]);
        let mut descriptor_b = descriptor_a.clone();
        descriptor_b.release_id = Some([0x33; RELEASE_ID_LENGTH]);

        let hash_a = cache_encryption_record_binding_hash_hex(&descriptor_a).unwrap();
        let hash_b = cache_encryption_record_binding_hash_hex(&descriptor_b).unwrap();
        assert_eq!(hash_a.len(), 64);
        assert_ne!(hash_a, hash_b);
    }
}