coremlit 0.1.0

//! The public forced aligner: [`Aligner`] wraps `asry`'s
//! [`EmissionsAligner`] around alignkit's
//! CoreML `Encoder` and drives one chunk
//! end-to-end — VAD → `prepare` → CoreML encode → `finish` — into per-word
//! [`TimeRange`]s.
//!
//! # What the aligner no longer owns
//!
//! Everything except the CoreML encoder and the pairing of the encoder with
//! a vocabulary and a contract. The redesigned asry seam ([`EmissionsAligner`])
//! owns the tokenizer, the normalizer, the per-chunk vocab-size handshake, the
//! silence mask, and every validator; alignkit hands it exactly one thing it
//! cannot compute — the emissions — and reads back the words. So this type is
//! thin: an `Encoder`, the seam built from a [`Vocabulary`] with the blank
//! and stride of the model's [`AcousticContract`], and the [`AlignerOptions`]
//! baked into that seam at construction.

use core::{num::NonZeroUsize, sync::atomic::AtomicBool, time::Duration};
use std::{collections::BTreeSet, path::Path};

use crate::ComputeUnits;
use asry::{
  Lang, TimeRange,
  emissions::{
    DynTextNormalizer, EmissionsAligner, EmissionsError, EmissionsFailure, OovDecision,
    OovDetection, OovResolution, OutputClock, PreparedChunk, SpeechCoverage, SpeechSpans,
    UnitAlignment,
  },
};
use tokenizers::{Tokenizer, models::ModelWrapper};

use crate::audio::align::{
  acoustic::{AcousticContract, check_tokenization},
  encode::{DEFAULT_ENCODER_COMPUTE, Encoder, EncoderInput},
  error::{
    AlignError, AlignerError, BlankOutOfVocabulary, InputTooLong, Refusal, RefusedOov,
    ReservedSetMismatch, VocabularyMismatch,
  },
  vocab::Vocabulary,
};

/// Default minimum speech coverage a word must clear to survive (`0.5`) —
/// asry's [`SpeechCoverage::DEFAULT`](asry::emissions::SpeechCoverage::DEFAULT).
pub const DEFAULT_MIN_SPEECH_COVERAGE: f32 = SpeechCoverage::DEFAULT.get();

/// Default maximum contiguous silent run tolerated inside a word's span
/// (80 ms) — asry's `DEFAULT_MAX_INTRA_SILENT_RUN`.
pub const DEFAULT_MAX_INTRA_SILENT_RUN: Duration = asry::emissions::DEFAULT_MAX_INTRA_SILENT_RUN;

#[cfg(feature = "serde")]
fn default_min_speech_coverage() -> f32 {
  DEFAULT_MIN_SPEECH_COVERAGE
}
#[cfg(feature = "serde")]
fn default_max_intra_silent_run() -> Duration {
  DEFAULT_MAX_INTRA_SILENT_RUN
}
#[cfg(feature = "serde")]
fn default_compute() -> ComputeUnits {
  DEFAULT_ENCODER_COMPUTE
}

/// Construction options for [`Aligner`] (rust-options-pattern): the two seam
/// knobs asry's [`EmissionsAligner`] builder exposes that have a meaningful
/// range for this model, plus the CoreML compute placement handed to the
/// `Encoder`.
///
/// Deliberately NOT here: `hop_samples`. The seam builder accepts one, but a
/// model's stride is a fact of its graph, stated once in its
/// [`AcousticContract`], and the encoder truncates by that same stride without
/// consulting any option — so a caller-set stride would reach only the seam
/// half, declaring a stride the encoder never used: a second, driftable source
/// of truth. It would not even move the boundaries, which asry maps by the
/// encoder-driven frame count alone (frame `k` of `T` covers samples
/// `[k·n/T, (k+1)·n/T)` of the chunk's `n` real ones), and asry's per-chunk
/// frame-count check, a band of counts per hop, cannot pin it: on `jfk.wav`
/// (549 frames of 176,000 samples) it accepts a hop of 321 as well as 320. The
/// seam is wired from the contract's stride instead (`build_seam`).
///
/// These are **construction-time**: they are fed to the builder / model load
/// once and baked in, so there are no post-construction setters on
/// [`Aligner`] — rebuild via [`Aligner::from_paths_with`] to change them.
/// (The `with_`/`set_` pairs here mutate an `AlignerOptions` *value* before
/// it reaches construction.)
#[derive(Debug, Clone, Copy, PartialEq)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub struct AlignerOptions {
  #[cfg_attr(feature = "serde", serde(default = "default_min_speech_coverage"))]
  min_speech_coverage: f32,
  #[cfg_attr(feature = "serde", serde(default = "default_max_intra_silent_run"))]
  max_intra_silent_run: Duration,
  #[cfg_attr(feature = "serde", serde(default = "default_compute"))]
  compute: ComputeUnits,
}

impl Default for AlignerOptions {
  fn default() -> Self {
    Self::new()
  }
}

impl AlignerOptions {
  /// Options matching the crate defaults: [`DEFAULT_MIN_SPEECH_COVERAGE`],
  /// [`DEFAULT_MAX_INTRA_SILENT_RUN`], [`DEFAULT_ENCODER_COMPUTE`].
  #[must_use]
  pub const fn new() -> Self {
    Self {
      min_speech_coverage: DEFAULT_MIN_SPEECH_COVERAGE,
      max_intra_silent_run: DEFAULT_MAX_INTRA_SILENT_RUN,
      compute: DEFAULT_ENCODER_COMPUTE,
    }
  }

  /// Minimum speech coverage a word must clear to survive.
  ///
  /// Coerced through
  /// [`SpeechCoverage::clamped`](asry::emissions::SpeechCoverage::clamped) at
  /// construction (`NaN` → default, out-of-range clamps to `[0, 1]`), so a
  /// bad value here can never silently disable the coverage filter.
  #[must_use]
  pub const fn min_speech_coverage(&self) -> f32 {
    self.min_speech_coverage
  }
  /// Builder form of [`Self::set_min_speech_coverage`].
  #[must_use]
  pub const fn with_min_speech_coverage(mut self, coverage: f32) -> Self {
    self.set_min_speech_coverage(coverage);
    self
  }
  /// Sets [`Self::min_speech_coverage`] in place.
  pub const fn set_min_speech_coverage(&mut self, coverage: f32) -> &mut Self {
    self.min_speech_coverage = coverage;
    self
  }

  /// Maximum contiguous silent run tolerated inside a word's span.
  #[must_use]
  pub const fn max_intra_silent_run(&self) -> Duration {
    self.max_intra_silent_run
  }
  /// Builder form of [`Self::set_max_intra_silent_run`].
  #[must_use]
  pub const fn with_max_intra_silent_run(mut self, run: Duration) -> Self {
    self.set_max_intra_silent_run(run);
    self
  }
  /// Sets [`Self::max_intra_silent_run`] in place.
  pub const fn set_max_intra_silent_run(&mut self, run: Duration) -> &mut Self {
    self.max_intra_silent_run = run;
    self
  }

  /// Which hardware CoreML may schedule the encoder on. Defaults to
  /// [`DEFAULT_ENCODER_COMPUTE`] (`ComputeUnits::CpuOnly`).
  ///
  /// **Overriding this to an ANE placement (`ComputeUnits::All` or
  /// `CpuAndNeuralEngine`) corrupts the emissions** — the model's fp16
  /// `log(softmax(·))` tail underflows to a `-45440` sentinel on 16.7% of cells
  /// and shifts real word timings by hundreds of milliseconds. That is a
  /// property of the model artifact, not of this crate, and nothing here can
  /// recover the underflowed cells.
  ///
  /// On the staged model it is not silent on the audio that exposes it:
  /// [`Aligner::align_chunk`] fails a real-speech chunk on an ANE placement with
  /// [`AlignError::CorruptEmissions`], which names this placement (see the
  /// staged contract's
  /// [`SentinelBand`](crate::audio::align::acoustic::SentinelBand)). Detection is
  /// input-dependent — the `log(0)` sentinel only appears once a class posterior
  /// falls under the fp16 floor, so a pure-silence or low-tone chunk can pass
  /// even here. Real speech can expose it, measured on `jfk.wav`. The guard is on
  /// the emission VALUES, not the input category or the placement, so a
  /// numerically-clean non-default placement — `CpuAndGpu`, measured
  /// `min = -30.02` — still works. There is simply nothing to buy: `CpuOnly` is
  /// also the fastest correct placement. Read [`DEFAULT_ENCODER_COMPUTE`]'s doc
  /// before changing this. A model loaded with its own contract has no band to
  /// guard it: check its emissions on a placement before relying on it.
  #[must_use]
  pub const fn compute(&self) -> ComputeUnits {
    self.compute
  }
  /// Builder form of [`Self::set_compute`].
  #[must_use]
  pub const fn with_compute(mut self, compute: ComputeUnits) -> Self {
    self.set_compute(compute);
    self
  }
  /// Sets [`Self::compute`] in place.
  pub const fn set_compute(&mut self, compute: ComputeUnits) -> &mut Self {
    self.compute = compute;
    self
  }
}

/// **This spelling is persisted by downstream derivation fingerprints — change
/// it only with a major bump.**
///
/// `key=value` pairs in declaration order, joined by `,`: [`Self::min_speech_coverage`]
/// as `{}` of `f32` (the shortest round-tripping repr); [`Self::max_intra_silent_run`]
/// as [`humantime::format_duration`]'s text (`"80ms"`, `"1s"`, …) — the same
/// grammar this workspace already renders `Duration` as elsewhere (ingraph's
/// `[registry]` seat); [`Self::compute`] composing [`ComputeUnits`]'s own
/// `Display` verbatim (its snake_case wire word, e.g. `"cpu_only"`) — that is
/// the one place ITS spelling can change, and a drift there fails the same
/// pinning test this one does.
///
/// For example, `AlignerOptions::new()` prints
/// `min_speech_coverage=0.5,max_intra_silent_run=80ms,compute=cpu_only`.
impl core::fmt::Display for AlignerOptions {
  fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
    write!(
      f,
      "min_speech_coverage={},max_intra_silent_run={},compute={}",
      self.min_speech_coverage,
      humantime::format_duration(self.max_intra_silent_run),
      self.compute
    )
  }
}

/// Build asry's [`EmissionsAligner`] the way
/// [`Aligner::from_paths_with_vocabulary`] does: the tokenizer document
/// `vocabulary` writes for `contract`, every property of the model the builder
/// lets its caller state —
/// the blank, the stride, the receptive field, the word delimiter and the
/// letter case — read off `contract`, and `options` fed to the builder; then
/// the columns the seam reserves, read back and checked against the contract's
/// non-lexical set (`check_reserved`).
///
/// Each statement is the contract's, never the table's and never asry's
/// default: the defaults are English wav2vec2's (`|`, upper case, 400 samples, a
/// blank found by name), which describe one family of models and say nothing
/// about another. asry takes a statement at its word.
///
/// Factored out of [`Aligner::from_paths_with_vocabulary`] so the wiring is
/// unit-testable without a CoreML model.
///
/// # Errors
/// [`AlignerError::Seam`] if asry's builder refuses the document, the
/// normalizer or the statements; [`AlignerError::ReservedSetMismatch`] if the
/// seam reserves other columns than the contract declares non-lexical.
fn build_seam(
  language: Lang,
  vocabulary: &Vocabulary,
  contract: &AcousticContract,
  normalizer: DynTextNormalizer,
  options: &AlignerOptions,
) -> Result<EmissionsAligner, AlignerError> {
  let geometry = contract.geometry();
  let tokenization = contract.tokenization();
  // The document declares the contract's blank, delimiter and specials as
  // special added tokens: the reserved columns asry never spells a character
  // onto.
  let document = vocabulary.tokenizer_json(contract);
  let seam = EmissionsAligner::builder(language, &document)
    .normalizer(normalizer)
    // NOT an option (see `AlignerOptions`): the stride handed to the seam here
    // is the one the encoder truncates the emissions by, the contract's — the
    // one that, via `T`, sets the grid asry times words on — and asry's
    // frame-count band is too wide to catch the two disagreeing.
    .hop_samples(geometry.stride())
    // The length `prepare` pads a shorter chunk to, and the field asry's
    // frame-count check reads: the encoder truncates by the same one.
    .receptive_field_samples(geometry.receptive_field())
    .word_delimiter(tokenization.delimiter().seam_token())
    .letter_case(tokenization.case().seam())
    .min_speech_coverage(SpeechCoverage::clamped(options.min_speech_coverage()))
    .max_intra_silent_run(options.max_intra_silent_run())
    // MANDATORY: without it the builder GUESSES a blank by name (`<pad>`, then
    // `[PAD]`, then `<blank>`), which fails on the bundled table (its blank is
    // `-`) and picks a wrong column of a table holding an ordinary `<pad>`. The
    // blank is the contract's statement, never the table's.
    .blank_token_id(contract.blank())
    .build()?;
  check_reserved(
    &seam,
    &document,
    vocabulary.non_lexical(contract.blank(), tokenization),
  )?;
  Ok(seam)
}

/// The columns `seam` reserves, read back: the blank and the word delimiter it
/// was stated, from its own readers, and the unknown token and the special
/// added tokens of `document`, the tokenizer document it was built from. asry
/// reserves that union (its `ReservedIds`) and keeps it, like its tokenizer,
/// off its public API, so `document` is parsed once more here, by the
/// `tokenizers` crate asry parses it with and by the call asry's builder makes
/// on a document that names its model's type (`Tokenizer::from_bytes`), and
/// read the way asry reads it.
///
/// # Errors
/// [`AlignerError::Seam`] if `document` does not parse here, which a document
/// asry's builder has just parsed does only if the two parses are not one
/// `tokenizers` build.
fn seam_reserved(
  seam: &EmissionsAligner,
  document: &[u8],
) -> Result<BTreeSet<usize>, AlignerError> {
  let tokenizer = Tokenizer::from_bytes(document).map_err(|error| {
    AlignerError::Seam(EmissionsError::Config(EmissionsFailure::new(
      format!("the tokenizer document the seam was built from does not parse again: {error}")
        .into(),
    )))
  })?;
  let specials = tokenizer
    .get_added_vocabulary()
    .get_added_tokens_decoder()
    .iter()
    .filter(|(_, token)| token.special)
    .map(|(&id, _)| id);
  // The document's model is the `WordLevel` table `Vocabulary::tokenizer_json`
  // writes, whose declared unknown token asry reserves where the table spells
  // it.
  let unknown = if let ModelWrapper::WordLevel(model) = tokenizer.get_model() {
    tokenizer.token_to_id(&model.unk_token)
  } else {
    None
  };
  Ok(
    specials
      .chain([seam.blank_token_id()])
      .chain(tokenizer.token_to_id(seam.word_delimiter()))
      .chain(unknown)
      .filter_map(|id| usize::try_from(id).ok())
      .collect(),
  )
}

/// The load-time check that `seam` reserves exactly the columns `declared`
/// names: the contract's non-lexical set ([`Vocabulary::non_lexical`]), which
/// its tokenizer document declares special.
///
/// The declaration is what asry reserves a special by, and a parse can drop
/// one: the `tokenizers` crate skips an added token whose content is empty
/// (`AddedVocabulary::add_tokens`). A declared column left unreserved could be
/// scored for a wildcard, which then answers a plausible and wrong timing; a
/// lexical column reserved could never be spelled. Either is wrong for every
/// chunk, so the pair is refused here, by name, before the first.
///
/// # Errors
/// [`AlignerError::ReservedSetMismatch`] if the two sets differ; as
/// `seam_reserved` otherwise.
fn check_reserved(
  seam: &EmissionsAligner,
  document: &[u8],
  declared: BTreeSet<usize>,
) -> Result<(), AlignerError> {
  let reserved = seam_reserved(seam, document)?;
  if reserved == declared {
    Ok(())
  } else {
    Err(AlignerError::ReservedSetMismatch(ReservedSetMismatch::new(
      declared.into_iter().collect(),
      reserved.into_iter().collect(),
    )))
  }
}

/// The load-time check of the contract's blank against the vocabulary: the
/// blank must be one of the table's ids, `0..vocabulary`.
///
/// It is the check the table allows. A flat table does not say which of its
/// columns is the blank, so the contract names it; what cannot be right is a
/// blank that is no column at all. asry's builder takes the id at its word and
/// only its trellis refuses it, on every chunk; a pair that is wrong for every
/// chunk is refused here, by name, before the first.
fn check_blank(blank: u32, vocabulary: NonZeroUsize) -> Result<(), AlignerError> {
  if usize::try_from(blank).is_ok_and(|blank| blank < vocabulary.get()) {
    Ok(())
  } else {
    Err(AlignerError::BlankOutOfVocabulary(
      BlankOutOfVocabulary::new(blank, vocabulary.get()),
    ))
  }
}

/// The load-time handshake: the seam's `vocabulary` must have exactly one
/// entry per class of the `model`'s CTC head.
///
/// asry re-checks the width on every chunk (`EmissionsError::VocabMismatch` in
/// `finish`), but a pair that disagrees is wrong for EVERY chunk, so it is
/// refused at load, by name, before the first one.
fn check_vocabulary_width(
  vocabulary: NonZeroUsize,
  model: NonZeroUsize,
) -> Result<(), AlignerError> {
  if vocabulary == model {
    Ok(())
  } else {
    Err(AlignerError::VocabularyMismatch(VocabularyMismatch::new(
      vocabulary.get(),
      model.get(),
    )))
  }
}

/// The `requested` [`AlignerOptions`] as the seam actually APPLIES them — the
/// effective state [`Aligner::options`] must report.
///
/// The seam coerces `min_speech_coverage` through
/// [`SpeechCoverage::clamped`](asry::emissions::SpeechCoverage::clamped) at
/// construction (`NaN` → default, out-of-range → `[0, 1]`), so the requested
/// value and the applied one can differ. This reads the applied coverage back
/// OUT of the built `seam` rather than re-clamping here, so `options()` can never
/// drift from what the seam does: the seam's own clamp is the single source of
/// truth. `max_intra_silent_run` and `compute` are not coerced, so they pass
/// through from `requested` unchanged.
fn effective_options(seam: &EmissionsAligner, requested: &AlignerOptions) -> AlignerOptions {
  requested.with_min_speech_coverage(seam.min_speech_coverage().get())
}

/// Per-language forced aligner over a CoreML CTC encoder.
///
/// Wraps alignkit's CoreML `Encoder`, asry's [`EmissionsAligner`] seam built
/// from a [`Vocabulary`] and the model's [`AcousticContract`] — the encoder's
/// CTC head width checked equal to the vocabulary's size, the contract's blank
/// checked to be one of its ids, and its geometry checked against the model's
/// declared window and frames, all at load — and the [`AlignerOptions`] baked
/// into that seam. Build one per language with [`from_paths`](Self::from_paths)
/// (the staged model, its bundled English table and its own contract) or
/// [`from_paths_with_vocabulary`](Self::from_paths_with_vocabulary) (any model,
/// the table it ships beside it and the contract its caller states), then drive
/// it per chunk with [`align_chunk`](Self::align_chunk).
///
/// [`align_chunk`](Self::align_chunk) takes `&self`: the CoreML `Model`
/// predicts without `&mut`, and asry's `prepare`/`finish` are `&self`, so —
/// unlike asry's own ORT `Aligner`, which its registry wraps in a `Mutex` —
/// this one needs no interior mutability.
pub struct Aligner {
  encoder: crate::audio::align::encode::Encoder,
  inner: EmissionsAligner,
  options: AlignerOptions,
}

impl Aligner {
  /// Load an aligner for `language` from the staged `base960h_aligner.mlmodelc`
  /// at `model_path`, using the crate's **bundled** 29-class English table
  /// ([`Vocabulary::bundled`]), the model's own contract
  /// ([`AcousticContract::BASE960H`]) and the default [`AlignerOptions`].
  ///
  /// The bundled table and the contract are that artifact's. Any other model —
  /// one whose CTC head spells another alphabet, or whose front end is not
  /// wav2vec2's — is loaded with [`Self::from_paths_with_vocabulary`], its own
  /// table and a contract its caller states.
  ///
  /// # Errors
  /// As [`Self::from_paths_with_vocabulary`].
  pub fn from_paths(
    language: Lang,
    model_path: &Path,
    normalizer: DynTextNormalizer,
  ) -> Result<Self, AlignerError> {
    Self::from_paths_with(language, model_path, normalizer, AlignerOptions::new())
  }

  /// [`Self::from_paths`] with explicit [`AlignerOptions`].
  ///
  /// # Errors
  /// As [`Self::from_paths_with_vocabulary`].
  pub fn from_paths_with(
    language: Lang,
    model_path: &Path,
    normalizer: DynTextNormalizer,
    options: AlignerOptions,
  ) -> Result<Self, AlignerError> {
    Self::from_paths_with_vocabulary(
      language,
      model_path,
      &Vocabulary::bundled(),
      &AcousticContract::BASE960H,
      normalizer,
      options,
    )
  }

  /// Load an aligner for `language` from the compiled CoreML model at
  /// `model_path`, the `vocabulary` it was trained with — the table that ships
  /// beside it, read with [`Vocabulary::from_file`] — and its `contract`: the
  /// id of its CTC blank and its front end's geometry, which neither the model
  /// nor the table declares.
  ///
  /// This is the door a per-language aligner is built through: the model
  /// supplies the alphabet, and its caller states the rest. Nothing on it is
  /// guessed, and what the model and the table declare is checked against the
  /// statement, each refused by name at load:
  ///
  /// - the contract's blank must be one of the table's ids
  ///   ([`AlignerError::BlankOutOfVocabulary`]), checked before the model loads;
  /// - the contract's geometry must make the model's declared frame count of
  ///   its declared window ([`AlignerError::FrameCountMismatch`]);
  /// - the contract's tokenization must be one this table and this normalizer
  ///   agree with ([`AlignerError::Tokenization`]), checked before the model
  ///   loads;
  /// - the seam built from the table under the contract must reserve exactly
  ///   the contract's non-lexical columns — its blank, its delimiter and its
  ///   declared specials — read back from the seam and the tokenizer document
  ///   it parsed ([`AlignerError::ReservedSetMismatch`]);
  /// - the model's window must be at least the contract's receptive field, the
  ///   length asry pads a short chunk to ([`AlignerError::ContractMismatch`] on
  ///   `waveform`);
  /// - a head stated as log-probabilities must be one whose normalization can
  ///   be checked ([`AlignerError::UnprovableNormalization`]);
  /// - the model's CTC head width, read at load, must equal `vocabulary`'s size
  ///   ([`AlignerError::VocabularyMismatch`]): each id of the table is the
  ///   column its token is scored in.
  ///
  /// The model must be a fixed-window CTC encoder over `V` classes, fed 16 kHz
  /// audio (see the [`encode`](crate::audio::align::encode) module doc).
  ///
  /// With the `tracing` feature: an `alignkit.aligner.load` span at `INFO`,
  /// with the CoreML load (`alignkit.encoder.load`) nested inside it. Its
  /// `aligner_language` field is the language the aligner is built for. The
  /// [`Self::from_paths`] and [`Self::from_paths_with`] loads open the same
  /// span, through this constructor.
  ///
  /// # Errors
  /// [`AlignerError::BlankOutOfVocabulary`] if the contract's blank is no id of
  /// the table; [`AlignerError::Tokenization`] if the table or the normalizer
  /// contradicts its tokenization;
  /// [`AlignerError::Load`] / [`AlignerError::ContractMismatch`] /
  /// [`AlignerError::UnsatisfiableInput`] / [`AlignerError::UnsatisfiableState`]
  /// if CoreML rejects the model or its I/O contract disagrees with this door's
  /// (a window shorter than the contract's receptive field among them);
  /// [`AlignerError::FrameCountMismatch`] if its declared window and frames
  /// disagree with the contract's geometry;
  /// [`AlignerError::UnprovableNormalization`] if the contract states
  /// log-probabilities for a head too wide to check;
  /// [`AlignerError::Seam`] if asry's builder rejects the vocabulary or the
  /// normalizer (e.g. a normalizer that needs a `|` delimiter the table lacks);
  /// [`AlignerError::ReservedSetMismatch`] if the seam reserves other columns
  /// than the contract declares non-lexical;
  /// [`AlignerError::VocabularyMismatch`] if the table's size is not the model's
  /// CTC head width.
  #[cfg_attr(
    feature = "tracing",
    tracing::instrument(
      name = "alignkit.aligner.load",
      level = "info",
      skip_all,
      fields(
        aligner_language = ?language,
        model_path = ?model_path,
        compute = ?options.compute(),
        vocabulary = vocabulary.size().get(),
        contract = ?contract,
      ),
    )
  )]
  pub fn from_paths_with_vocabulary(
    language: Lang,
    model_path: &Path,
    vocabulary: &Vocabulary,
    contract: &AcousticContract,
    normalizer: DynTextNormalizer,
    options: AlignerOptions,
  ) -> Result<Self, AlignerError> {
    // Before the model loads: the table, the normalizer and the contract alone
    // decide these.
    check_blank(contract.blank(), vocabulary.size())?;
    check_tokenization(
      contract.blank(),
      contract.tokenization(),
      vocabulary,
      normalizer.use_word_delimiter(),
    )
    .map_err(AlignerError::Tokenization)?;
    let encoder = Encoder::load(model_path, contract, options.compute())?;
    let inner = build_seam(language, vocabulary, contract, normalizer, &options)?;
    check_vocabulary_width(inner.vocab_size(), encoder.vocab_size())?;
    // `options()` must report EFFECTIVE state (F3): the seam coerced
    // `min_speech_coverage` through `SpeechCoverage::clamped`, so store what the
    // seam actually applies — read back out of it — not the requested value that
    // may have been out of range or NaN.
    let options = effective_options(&inner, &options);
    Ok(Self {
      encoder,
      inner,
      options,
    })
  }

  /// The language this aligner was built for.
  #[must_use]
  pub const fn language_ref(&self) -> &Lang {
    self.inner.language()
  }

  /// The **effective** [`AlignerOptions`] baked into this aligner's seam — the
  /// values actually in force, which are not always the ones requested at
  /// construction. In particular `min_speech_coverage` is the seam's *clamped*
  /// value ([`SpeechCoverage::clamped`](asry::emissions::SpeechCoverage::clamped):
  /// `NaN` → default, out-of-range → `[0, 1]`), so a caller that constructed the
  /// aligner with `2.0` reads back `1.0` here — the coverage the aligner will
  /// actually apply — never the un-applied request.
  #[must_use]
  pub const fn options(&self) -> AlignerOptions {
    self.options
  }

  /// The audio sample rate this aligner expects: 16 kHz, asry's analysis
  /// rate, and the only rate an
  /// [`AcousticGeometry`](crate::audio::align::acoustic::AcousticGeometry)
  /// takes. Callers resample to this first.
  #[must_use]
  pub const fn sample_rate(&self) -> u32 {
    asry::time::SAMPLE_RATE_HZ
  }

  /// The most samples one chunk may hold: the model's input window, read at
  /// load (960,000, 60 s, for the staged model). Callers chunk audio to at
  /// most this; [`Self::align_chunk`] refuses a longer chunk.
  #[must_use]
  pub const fn window_samples(&self) -> usize {
    self.encoder.window_samples()
  }

  /// The contract this aligner was built with.
  #[must_use]
  pub const fn contract(&self) -> &AcousticContract {
    self.encoder.contract()
  }

  /// Detect out-of-vocabulary characters in `text`, as data — no policy
  /// decision is made.
  ///
  /// Returns asry's [`OovDetection`], bound to `text` and to this aligner.
  /// Decide it with [`default_oov_policy`](asry::emissions::default_oov_policy)
  /// (or [`wildcard_all_policy`](asry::emissions::wildcard_all_policy),
  /// [`fail_closed_all_policy`](asry::emissions::fail_closed_all_policy), or a
  /// closure of your own), then hand the [`OovResolution`] to
  /// [`align_chunk`](Self::align_chunk) with the same text: asry refuses a
  /// resolution detected in another text or by another aligner. Its events are
  /// in the order the tokenizer meets them.
  ///
  /// A character the vocabulary cannot spell is an event
  /// ([`OovKind::Symbol`](asry::emissions::OovKind::Symbol)), never an error:
  /// asry looks each character up in the vocabulary and never runs the
  /// tokenizer's `encode`, whose `MissingUnkToken` on a table with no unknown
  /// token used to fail the whole chunk. A punctuation mark nobody reads aloud
  /// is no event at all: tokenization drops it.
  ///
  /// # Errors
  /// [`AlignError::Alignment`] if the text normalizer rejects the text, or its
  /// output disagrees with itself (its word count against its boundary map).
  /// Punctuation-only input yields no events, not an error.
  pub fn detect_oov(&self, text: &str) -> Result<OovDetection, AlignError> {
    Ok(self.inner.detect_oov(text)?)
  }

  /// Align one chunk end-to-end into per-word [`TimeRange`]s in `clock`'s
  /// output timebase.
  ///
  /// - `samples`: the chunk's 16 kHz f32 mono audio, at most
  ///   [`Self::window_samples`] (for the staged model
  ///   [`ENCODER_WINDOW_SAMPLES`](crate::audio::align::encode::ENCODER_WINDOW_SAMPLES)).
  /// - `sub_segments`: VAD speech spans in the chunk-local 1/16000 analysis
  ///   timebase. **Empty means "no VAD"** →
  ///   [`SpeechSpans::all_speech`](asry::emissions::SpeechSpans::all_speech),
  ///   not "all silence" (which would drop every word).
  /// - `text`: the transcript to align against `samples`.
  /// - `clock`: how stream sample indices map back to output-timebase
  ///   ranges; build with
  ///   [`OutputClock::new`](asry::emissions::OutputClock::new). This is
  ///   `asry`'s replacement for the old `Fn(u64, u64) -> TimeRange` closure.
  /// - `abort_flag`: cooperative cancellation, polled throughout `prepare`
  ///   and `finish`.
  /// - `resolution`: [`Self::detect_oov`] of this same `text`, decided. It is
  ///   consumed, so its decisions apply once, to the text they were made for.
  ///
  /// Returns the chunk's [`UnitAlignment`]: its words, or why it has none. A
  /// trivial chunk (text that normalises to nothing / yields no tokens) is
  /// `Unaligned(NoAlignableText)`, and its encoder is not run; a chunk whose
  /// every word fell outside its speech is `Unaligned(NoSurvivingWords)`. The
  /// two per-chunk outcomes that are not faults of the setup are NAMED errors
  /// instead: [`AlignError::Refused`] when the caller's decisions resolved a
  /// position `FailClosed` (it carries every refused position), and
  /// [`AlignError::NoAlignmentPath`] when the CTC lattice admits no path for
  /// this chunk's audio and tokens. Either way the ASR text is the caller's to
  /// keep; only per-word timings are missing. See the
  /// [`crate::audio::align::error`] module doc.
  ///
  /// With the `tracing` feature: one `alignkit.align_chunk` span at `DEBUG` per
  /// call, wrapping the whole VAD → prepare → encode → finish pass, with
  /// `alignkit.encoder.emissions` nested inside it. An unaligned chunk is a
  /// *success* that produces no words, which is exactly the state a caller
  /// ends up staring at a debugger over — its cause names which, and the span's
  /// `sub_segments` / `text_bytes` / `samples` fields say what it was given.
  /// Its `aligner_language` field is this aligner's own language: under an
  /// [`AlignmentSet`](crate::audio::align::registry::AlignmentSet), whose
  /// `alignkit.registry.align_chunk` span names the requested language, an
  /// [`AlignerKey::Any`](crate::audio::align::registry::AlignerKey::Any)
  /// fallback's span names the fallback's.
  ///
  /// # Errors
  /// [`AlignError::InputTooLong`] if `samples` exceeds the encoder window;
  /// [`AlignError::Span`] if `sub_segments` are not in the 1/16000 timebase;
  /// [`AlignError::Refused`] if a decision in `resolution` is `FailClosed`;
  /// [`AlignError::Prediction`] / [`AlignError::Tensor`] from the CoreML
  /// encode; [`AlignError::CorruptEmissions`] if a cell of the encoder's
  /// emission matrix is in the contract's sentinel band (on the staged model, an
  /// ANE placement set through [`AlignerOptions::with_compute`] — see
  /// [`crate::audio::align::acoustic::SentinelBand`]);
  /// [`AlignError::UnnormalizedEmissions`] if the encoder's emission matrix is not
  /// normalized log-probabilities (a raw-logit model swap — see
  /// [`crate::audio::align::encode::log_prob_sum_tolerance`]);
  /// [`AlignError::NoAlignmentPath`] if the lattice admits no path, or `samples`
  /// is empty and `text` has tokens to align;
  /// [`AlignError::Alignment`] for any other seam failure (stride / vocab /
  /// blank-id validation, a non-finite or positive log-probability,
  /// tokenization — a `resolution` detected in another text or by another
  /// aligner among them —, a word the clock cannot represent, abort).
  #[cfg_attr(
    feature = "tracing",
    tracing::instrument(
      name = "alignkit.align_chunk",
      level = "debug",
      skip_all,
      fields(
        aligner_language = ?self.language_ref(),
        samples = samples.len(),
        sub_segments = sub_segments.len(),
        text_bytes = text.len(),
        oov_decisions = resolution.resolved().len(),
      ),
    )
  )]
  pub fn align_chunk(
    &self,
    samples: &[f32],
    sub_segments: &[TimeRange],
    text: &str,
    clock: OutputClock,
    abort_flag: &AtomicBool,
    resolution: OovResolution,
  ) -> Result<UnitAlignment, AlignError> {
    if samples.len() > self.window_samples() {
      return Err(AlignError::InputTooLong(InputTooLong::new(
        samples.len(),
        self.window_samples(),
      )));
    }

    let speech = if sub_segments.is_empty() {
      SpeechSpans::all_speech()
    } else {
      SpeechSpans::from_time_ranges(sub_segments)?
    };

    // `prepare` consumes the resolution, so the positions it refuses are read
    // off it first.
    let refused = refused_positions(&resolution);
    let prepared = self
      .inner
      .prepare(samples, &speech, text, resolution, clock, abort_flag)
      .map_err(|err| seam_error(err, &refused))?;
    check_audio(&prepared)?;

    // asry has already silence-masked + receptive-field-padded the buffer, and
    // `encode_with` hands the encoder exactly THAT; the truncation formula needs
    // the real (pre-pad) sample count too. Both come off the one `PreparedChunk`
    // via `EncoderInput::from_prepared`: the padded buffer from
    // `encoder_input()`, the real length from asry's own `real_samples()` (the
    // same `samples.len()` we handed `prepare`). Reading both from one
    // authoritative object is what makes a mismatched real length
    // unrepresentable (F1). The emissions are made through the chunk, so they
    // answer it alone, and a trivial chunk's encoder is not run. This is the
    // only composition of a prepared chunk with an encoder: both are this
    // aligner's, built from one contract, and neither leaves it.
    let emissions = prepared.encode_with(|buffer| {
      debug_assert!(
        core::ptr::eq(buffer, prepared.encoder_input()),
        "asry hands the encoder the chunk's own prepared input"
      );
      self
        .encoder
        .emissions(EncoderInput::from_prepared(&prepared))
    })?;

    self
      .inner
      .finish(prepared, emissions, abort_flag)
      .map_err(|err| seam_error(err, &refused))
  }
}

/// A chunk with tokens to align and no audio has no alignment path: no frame
/// can carry a token. Named before the encoder runs, as the lattice names a
/// chunk too short for its tokens. Left to the seam, the encoder's zero frames
/// for zero real samples would meet asry's frame-count check, which reads a
/// padded input of one receptive field and refuses them as a stride mismatch,
/// blaming a model that has none.
fn check_audio(prepared: &PreparedChunk<'_>) -> Result<(), AlignError> {
  if prepared.is_trivial() || prepared.real_samples() > 0 {
    return Ok(());
  }
  Err(AlignError::NoAlignmentPath(EmissionsFailure::new(
    "the chunk holds no audio, so no frame can carry its tokens".into(),
  )))
}

/// The positions `resolution` resolves `FailClosed`, in its order: what a
/// refusal of the chunk names, each under the language this aligner read the
/// text in (an [`AlignmentSet`](crate::audio::align::registry::AlignmentSet)
/// restates them under its request).
fn refused_positions(resolution: &OovResolution) -> Vec<RefusedOov> {
  resolution
    .resolved()
    .iter()
    .filter(|resolved| resolved.decision() == OovDecision::FailClosed)
    .map(|resolved| RefusedOov::detected(resolved.event()))
    .collect()
}

/// The seam's error, NAMED: a refusal by the caller's OOV decisions is
/// [`AlignError::Refused`] carrying every refused position, a chunk the
/// lattice cannot align is [`AlignError::NoAlignmentPath`], and every other
/// failure is [`AlignError::Alignment`].
///
/// The one classifier both seam calls in [`Aligner::align_chunk`] go through,
/// so each case is named wherever it arises — in practice a refusal arises in
/// `prepare`, where asry tokenizes, and a no-path chunk in `finish`, where the
/// trellis runs. Neither may become an unaligned result, which is a SUCCESS's
/// answer — a chunk with nothing to align, or one whose words all fell outside
/// its speech.
///
/// asry's `SemanticOutOfVocab` carries only a message, so the refused positions
/// are `refused`: [`refused_positions`] of the caller's resolution, read before
/// `prepare` consumed it. That is exact, not a guess: asry applies a resolution
/// only in the text and by the aligner its detection read, so its decisions
/// are this text's detected events, and asry refuses only at a `FailClosed`
/// one; the `FailClosed` decisions are precisely the positions the caller's
/// policy refused. With none of them — which asry's contract rules out — the
/// error stays asry's own rather than become a refusal that names nothing.
fn seam_error(err: EmissionsError, refused: &[RefusedOov]) -> AlignError {
  match err {
    EmissionsError::SemanticOutOfVocab(failure) => {
      if refused.is_empty() {
        AlignError::Alignment(EmissionsError::SemanticOutOfVocab(failure))
      } else {
        AlignError::Refused(Refusal::new(refused.to_vec()))
      }
    }
    EmissionsError::NoAlignmentPath(failure) => AlignError::NoAlignmentPath(failure),
    other => AlignError::Alignment(other),
  }
}

#[cfg(test)]
mod tests;